@itutoring/itutoring_application_js_api 1.5.6 → 1.5.8

package/.idea/iTutoring_Application_API-js.iml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/tmp" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/iTutoring_Application_API-js.iml" filepath="$PROJECT_DIR$/.idea/iTutoring_Application_API-js.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

package/README.md

@@ -3,4 +3,4 @@
 This package contains a javascript API for iTutoring Application.  
 In order to use this API you need to obtain an API key.
 
-API Documentation for iTutoring Application can be found here: TO BE SOON
+API Documentation for iTutoring Application can be found here: Private only

package/apiController.js

@@ -2,7 +2,7 @@ import CookiesManager from "./CookiesManager";
 import { R_KEYs } from "./objects/Enums";
 
 /**
- * Main class for comunicating with our backend REST api.
+ * Main class for communicating with our backend REST api.
  */
 class APIController
 {
@@ -15,17 +15,17 @@ class APIController
 
     /**
      * R_KEY MUST be loaded before calling this method!
-     * @returns Returns apropriate rest url based on current server.
+     * @returns Returns appropriate rest url based on current server.
      */
     static REST_URL()
     {
-        if (location.hostname == 'localhost' || this.#R_KEY == R_KEYs.r_key_test)
+        if (location.hostname === 'localhost' || this.#R_KEY === R_KEYs.r_key_test)
         {
             return "https://api.test.itutoring.cz/";
 
         }
 
-        if (this.#R_KEY == R_KEYs.r_key_live)
+        if (this.#R_KEY === R_KEYs.r_key_live)
         {
             return "https://api.itutoring.cz/";
         }
@@ -33,8 +33,8 @@ class APIController
 
     static CreateVisitorSession()
     {
-        var id = Date.now();
-        var date = new Date();
+        const id = Date.now();
+        const date = new Date();
         date.setTime(date.getTime() + (7 * 24 * 60 * 60 * 1000));
 
         CookiesManager.SetCookie("session", id, date.toUTCString());
@@ -53,13 +53,13 @@ class APIController
         if (this.UserSource != null)
             return;
 
-        var urlParams = new URLSearchParams(window.location.search);
+        const urlParams = new URLSearchParams(window.location.search);
         if (urlParams.has("o"))
         {
-            var source = urlParams.get("o");
+            const source = urlParams.get("o");
             if (this.UserSource == null)
             {
-                var date = new Date();
+                const date = new Date();
                 date.setTime(date.getTime() + (30 * 24 * 60 * 60 * 1000));
                 CookiesManager.SetCookie("_o", source, date.toUTCString());
                 this.UserSource = source;
@@ -67,6 +67,41 @@ class APIController
         }
     }
 
+    static ResolveResponse(request)
+    {
+        const json = JSON.parse(request.responseText);
+        if (json.code ===200)
+        {
+            // check for redirect
+            if (json.data === "redirect" && json.url !== undefined)
+            {
+                window.location.href =  json.url;
+            }
+            return (json.data);
+        }
+        if (json.code === 400)
+        {
+            console.log("API Error:");
+            console.log("Error: " + json.error_message);
+            console.log("ErrorCode: " + json.error_code);
+            console.log("StackTrace: " + json.stack_trace);
+            const error = {
+                error: {
+                    message: json.error_message,
+                    code: json.error_code,
+                    stackTrace: json.stack_trace
+                }
+            };
+            if (APIController.onErrorReceived !== null && APIController.onErrorReceived !== undefined)
+            {
+                APIController.onErrorReceived(error);
+            }
+
+            return (JSON.stringify(error));
+        }
+    }
+
+
     /**
      * 
      * @param module "Name of API module"
@@ -81,44 +116,16 @@ class APIController
 
         return new Promise(resolve =>
         {
-            var args = APIController.GetArgsFromArray(data);
+            const args = APIController.GetArgsFromArray(data);
 
-            var request = new XMLHttpRequest();
+            const request = new XMLHttpRequest();
             request.withCredentials = true;
             request.open("GET", APIController.REST_URL() + module + "/" + method + "?" + args, true);
             request.onreadystatechange = function ()
             {
-                if (request.readyState == 4)
+                if (request.readyState === 4)
                 {
-                    var json = JSON.parse(request.responseText);
-                    if (json.code ==200)
-                    {
-                        // check for redirect
-                        if (json.data == "redirect" && json.url != undefined)
-                        {
-                            window.location.href =  json.url;
-                        }
-                        resolve(json.data);
-                    }
-                    if (json.code == 400)
-                    {
-                        console.log("API Error:");
-                        console.log("Error: " + json.error_message);
-                        console.log("ErrorCode: " + json.error_code);
-                        console.log("StackTrace: " + json.stack_trace);
-                        var error = {
-                            error: {
-                                message: json.error_message,
-                                code: json.error_code,
-                                stackTrace: json.stack_trace
-                            }
-                        };
-                        resolve(JSON.stringify(error));
-                        if (APIController.onErrorReceived != null)
-                        {
-                            APIController.onErrorReceived(error);
-                        }
-                    }
+                   resolve(APIController.ResolveResponse(request));
                 }
             }
 
@@ -134,10 +141,11 @@ class APIController
     }
 
     /**
-     * 
+     *
      * @param module "Name of API module"
      * @param method "Name of API method "
      * @param data "data must be as array - key, value pair. They'll be passed into the request"
+     * @param file
      * @returns "Response from server"
      */
     static async Post(module, method, data, file = null)
@@ -147,53 +155,25 @@ class APIController
 
         return new Promise(resolve =>
         {
-            var formData = new FormData();
+            let formData = new FormData();
             if (file != null)
             {
-                var formData = new FormData();
+                formData = new FormData();
                 formData.append("file", file);
 
 
             }
 
-            var args = APIController.GetArgsFromArray(data);
+            const args = APIController.GetArgsFromArray(data);
 
-            var request = new XMLHttpRequest();
+            const request = new XMLHttpRequest();
             request.open("POST", APIController.REST_URL() + module + "/" + method, true);
 
             request.onreadystatechange = function ()
             {
-                if (request.readyState == 4)
+                if (request.readyState === 4)
                 {
-                    var json = JSON.parse(request.responseText);
-                    if (json.code ==200)
-                    {
-                        // check for redirect
-                        if (json.data == "redirect" && json.url != undefined)
-                        {
-                            window.location.href = json.url;
-                        }
-                        resolve(json.data);
-                    }
-                    if (json.code == 400)
-                    {
-                        console.log("API Error:");
-                        console.log("Error: " + json.error_message);
-                        console.log("ErrorCode: " + json.error_code);
-                        console.log("StackTrace: " + json.stack_trace);
-                        var error = {
-                            error: {
-                                message: json.error_message,
-                                code: json.error_code,
-                                stackTrace: json.stack_trace
-                            }
-                        };
-                        resolve(JSON.stringify(error));
-                        if (APIController.onErrorReceived != null)
-                        {
-                            APIController.onErrorReceived(error);
-                        }
-                    }
+                    resolve(APIController.ResolveResponse(request));
                 }
             }
 
@@ -219,7 +199,7 @@ class APIController
 
     static GetArgsFromArray(args)
     {
-        var argsString = "";
+        let argsString = "";
 
         if (args != null)
         {
@@ -239,12 +219,12 @@ class APIController
     {
         return new Promise(resolve =>
         {
-            if (APIController.#R_KEY != "-1")
+            if (APIController.#R_KEY !== "-1")
             {
                 resolve(APIController.#R_KEY);
             }
 
-            // For localhost don't use xml config, but automaticly
+            // For localhost don't use xml config, but automatically
             // return test key.
             if (location.hostname === "localhost")
             {
@@ -255,9 +235,9 @@ class APIController
             {
                 fetch('/key_config.xml').then(response => response.text()).then((data) =>
                 {
-                    var parser = new DOMParser();
-                    var rKeyXML = parser.parseFromString(data, "text/xml");
-                    var rKey = rKeyXML.getElementsByTagName("key")[0].childNodes[0].nodeValue;
+                    const parser = new DOMParser();
+                    const rKeyXML = parser.parseFromString(data, "text/xml");
+                    const rKey = rKeyXML.getElementsByTagName("key")[0].childNodes[0].nodeValue;
 
                     APIController.#R_KEY = rKey;
                     resolve(APIController.#R_KEY);
@@ -270,13 +250,13 @@ class APIController
     {
         return new Promise(resolve =>
         {
-            if (APIController.#CLIENT_KEY != "-1")
+            if (APIController.#CLIENT_KEY !== "-1")
             {
                 resolve(APIController.#CLIENT_KEY);
             }
 
             let keyPath = '/client_key.xml';
-            // For localhost use different xml file (to make suer we won't revwrite the server key when uploading websites)
+            // For localhost use different xml file (to make suer we won't rewrite the server key when uploading websites)
             if (location.hostname === "localhost")
             {
                 keyPath = '/local_client_key.xml'
@@ -284,9 +264,9 @@ class APIController
 
             fetch(keyPath).then(response => response.text()).then((data) =>
             {
-                var parser = new DOMParser();
-                var keyXML = parser.parseFromString(data, "text/xml");
-                var key = keyXML.getElementsByTagName("key")[0].childNodes[0].nodeValue;
+                const parser = new DOMParser();
+                const keyXML = parser.parseFromString(data, "text/xml");
+                const key = keyXML.getElementsByTagName("key")[0].childNodes[0].nodeValue;
 
                 APIController.#CLIENT_KEY = key;
                 resolve(APIController.#CLIENT_KEY);
@@ -297,14 +277,14 @@ class APIController
 
     static async GetCurrentHostURl()
     {
-        if (location.hostname == 'localhost')
+        if (location.hostname === 'localhost')
         {
             return "http://localhost:3000";
         }
         else
         {
             var r_key = await this.GetLocalRKey();
-            if (r_key == R_KEYs.r_key_test)
+            if (r_key === R_KEYs.r_key_test)
             {
                 return "https://test.itutoring.cz";
             }
@@ -317,7 +297,7 @@ class APIController
 
     static IntToBool(value)
     {
-        return value == 1 ? true : false;
+        return value === 1;
     }
 
     static BoolToInt(value)

package/index.d.ts

@@ -39,6 +39,8 @@ import AuthUser from "./objects/AuthUser";
 import Authentication from "./modules/Authentication";
 import AttendanceEvent from "./objects/AttendanceEvent";
 import Toolkit from "./toolkit/Toolkit";
+import Pricing from "./modules/Pricing";
+import Reviews from "./modules/Reviews";
 
 import
     {
@@ -79,6 +81,8 @@ export
     Toolkit,
     TeacherProfileModule,
     LectorDatabase,
+    Pricing,
+    Reviews,
     
     Course,
     CourseReservation,

package/index.js

@@ -37,6 +37,8 @@ import Authentication from "./modules/Authentication";
 import AttendanceEvent from "./objects/AttendanceEvent";
 import Toolkit from "./toolkit/Toolkit";
 import TeacherProfileModule from "./modules/TeacherProfileModule";
+import Pricing from "./modules/Pricing";
+import Reviews from "./modules/Reviews";
 
 import
     {
@@ -77,6 +79,8 @@ export
     Toolkit,
     TeacherProfileModule,
     LectorDatabase,
+    Pricing,
+    Reviews,
 
     Course,
     CourseReservation,

package/modules/GoogleReviews.js

@@ -1,11 +1,19 @@
 import APIController from "../apiController";
 
+/**
+ * @deprecated Use general Reviews class instead.
+ */
 class GoogleReviews
 {
-    static #MODULE = "GoogleReviews";
+    static #MODULE = "Reviews";
 
     static #GET_RANDOM_REVIEW = "GetRandomReview";
 
+    /**
+     * @deprecated Use general Reviews class instead.
+     * @param {*} last_review_timestamp 
+     * @returns 
+     */
     static async GetRandomReview(last_review_timestamp = -1)
     {
         var review = await APIController.Get(this.#MODULE, this.#GET_RANDOM_REVIEW, {

package/modules/LectorDatabase.js

@@ -17,6 +17,7 @@ class LectorDatabase
     static #ADD_MODULE_ACCESS = "AddModuleAccess";
     static #REMOVE_MODULE_ACCESS = "RemoveModuleAccess";
     static #GET_COUNT_OF_LECTORS = "GetCountOfLectors";
+    static #GET_PUBLIC_PROFILES = "GetPublicProfiles";
 
     /**
      * desc: Get count of lectors
@@ -142,6 +143,20 @@ class LectorDatabase
             'access': access,
         });
     }
+
+    /**
+     * desc: Get public profiles
+     * @param {number} offset
+     * @param {number} maxCount
+     * @returns {Promise<array>}
+     */
+    static async getPublicProfiles(offset = 0, maxCount = -1)
+    {
+        return await APIController.Get(this.#MODULE, this.#GET_PUBLIC_PROFILES, {
+            'offset': offset,
+            'maxCount': maxCount,
+        });
+    }
 }
 
 export default LectorDatabase;

package/modules/Pricing.js

@@ -0,0 +1,62 @@
+import APIController from "../apiController";
+
+class Pricing
+{
+    static #MODULE = 'Pricing';
+
+    static #GET_PRICE_TABLE = 'GetPriceTable';
+    static #GET_LESSON_PRICE = 'GetLessonPrice';
+    static #GET_LESSON_PRICE_OFFER = 'GetLessonPriceOffer';
+
+    /**
+     * desc: Get price table
+     * 
+     * @returns 
+     */
+    static async getPriceTable()
+    {
+        var priceTable = await APIController.Get(this.#MODULE, this.#GET_PRICE_TABLE, {});
+
+        return priceTable;
+    }
+
+    /**
+     * desc: Get lesson price
+     * 
+     * @param {*} type 
+     * @param {*} len 
+     * @param {*} count 
+     * @returns 
+     */
+    static async getLessonPrice(type, len, count)
+    {
+        var price = await APIController.Get(this.#MODULE, this.#GET_LESSON_PRICE, {
+            'type': type,  
+            'len': len,
+            'count': count,
+        });
+
+        return price;
+    }
+
+    /**
+     * desc: Get lesson price offer
+     * 
+     * @param {*} type 
+     * @param {*} len 
+     * @param {*} count 
+     * @returns 
+     */
+    static async getLessonPriceOffer(type, len, count)
+    {
+        var price = await APIController.Get(this.#MODULE, this.#GET_LESSON_PRICE_OFFER, {
+            'type': type,  
+            'len': len,
+            'count': count,
+        });
+
+        return price;
+    }
+}
+
+export default Pricing;

package/modules/Reviews.js

@@ -0,0 +1,45 @@
+import APIController from "../apiController";
+
+class Reviews
+{
+    static #MODULE = "Reviews";
+
+    static #GET_RANDOM_REVIEW = "GetRandomReview";
+    static #GET_REVIEWS = "GetReviews";
+    static #GET_RATING = "GetRating";
+
+    /**
+     * desc: Get random review
+     * @returns 
+     */
+    static async GetRandomReview()
+    {
+        const review = await APIController.Get(this.#MODULE, this.#GET_RANDOM_REVIEW, {});
+
+        return JSON.parse(review);
+    }
+
+    /**
+     * desc: Get reviews
+     * @returns 
+     */
+    static async GetReviews()
+    {
+        const reviews = await APIController.Get(this.#MODULE, this.#GET_REVIEWS, {});
+
+        return JSON.parse(reviews);
+    }
+
+    /**
+     * desc: Get rating
+     * @returns 
+     */
+    static async GetRating()
+    {
+        const rating = await APIController.Get(this.#MODULE, this.#GET_RATING, {});
+
+        return JSON.parse(rating);
+    }
+}
+
+export default Reviews;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itutoring/itutoring_application_js_api",
-  "version": "1.5.6",
+  "version": "1.5.8",
   "description": "Javascript API for iTutoring Application",
   "main": "index.js",
   "types": "index.d.ts",