@itutoring/itutoring_application_js_api 1.0.0

package/modules/TeacherPortal.js

@@ -0,0 +1,208 @@
+import APIController from "./../apiController";
+import Reservation from "./../objects/Reservation";
+import Teacher from "./../objects/Teacher";
+
+class TeacherPortal
+{
+    /**
+    * Respective module name for this class
+    */
+    static #MODULE = "TeacherPortal";
+
+    // All method names
+    static #REMOVE_PERIODIC_TIME = "RemovePeriodicTime";
+    static #REMOVE_TIMES = "RemoveTimes";
+    static #SELECT_TIMES = "SelectTimes";
+    static #SET_TIMES_PERIODICLY = "SetTimePeriodicly";
+    static #GET_SUBJECTS = "GetSubjects";
+    static #GET_DATE_TIMES = "GetDayTimes";
+    static #GET_TEACHER_INFO = "GetTeacherInfo";
+    static #GET_RESERVATIONS = "GetReservations";
+    static #SET_BITMOJI = "SetBitmoji";
+    static #HAS_BITMOJI = "HasBitmoji";
+
+    static async HasBitmoji()
+    {
+        var res = await APIController.Get(this.#MODULE, this.#HAS_BITMOJI);
+
+        return APIController.IntToBool(res);
+    }
+
+    static async SetBitmoji(url)
+    {
+        await APIController.Get(this.#MODULE, this.#SET_BITMOJI, {
+            'url': encodeURIComponent(url),
+        });
+
+        return true;
+    }
+
+    /**
+     * Removes time for specific date and following weeks
+     * @param {*} from start time
+     * @param {*} to end time
+     * @param {*} date 
+     * @param {*} subject array of subjects 
+     * @param {*} period how many weeks from date (is treated as start date) will be affected
+     */
+    static async RemovePeriodicTime(from, to, date, subject, period)
+    {
+        var subjects = JSON.stringify(subject);
+
+        await APIController.Post(this.#MODULE, this.#REMOVE_PERIODIC_TIME, {
+            'from': from,
+            'to': to,
+            'date': date,
+            'subject': encodeURIComponent(subjects),
+            'period': period,
+        });
+    }
+
+    static async GetReservations()
+    {
+        var data = await APIController.Get(this.#MODULE, this.#GET_RESERVATIONS);
+
+        try
+        {
+            JSON.parse(data);
+        }
+        catch {
+            return null;
+        }
+
+        var array = JSON.parse(data);
+        var reservations = [];
+
+        for (const [key, value] of Object.entries(array))
+        {
+            var reservation = new Reservation();
+
+            reservation.Date = value['Date']
+            reservation.StartTime = value['StartTime'];
+            reservation.Subject = value['Subject'];
+            reservation.TeacherId = value['TeacherId'];
+            reservation.Note = value['Note'];
+            reservation.FirstName = value['FirstName'];
+            reservation.LastName = value['LastName'];
+            reservation.Email = value['Email'];
+            reservation.ID = value['ID'];
+
+            reservations[key] = reservation;
+        }
+
+        return reservations;
+    }
+
+    /**
+     * This method will return all availabe teacher info (Except password for security reasons).
+     */
+    static async GetTeacherInfo()
+    {
+        var data = await APIController.Get(this.#MODULE, this.#GET_TEACHER_INFO);
+
+        try
+        {
+            JSON.parse(data);
+        }
+        catch {
+            return null;
+        }
+
+        var teacherArray = JSON.parse(data);
+
+        var teacher = new Teacher();
+        teacher.Email = teacherArray['Email'];
+        teacher.Name = teacherArray['Name'];
+        teacher.ZoomMeeting = teacherArray['ZoomMeeting'];
+        teacher.ID = teacherArray['ID'];
+        teacher.TeachedLessons = teacherArray['TeachedLessons'];
+        teacher.Admin = teacherArray['Admin'];
+        teacher.BitmojiURL =decodeURIComponent(teacherArray['BitmojiURL']);
+
+        return teacher;
+    }
+
+    /**
+     * 
+     * @param {*} from 
+     * @param {*} to 
+     * @param {*} date 
+     * @param {*} subject array of subjects 
+     */
+    static async RemoveTimes(from, to, date, subject)
+    {
+        var subjects = JSON.stringify(subject);
+
+        await APIController.Post(this.#MODULE, this.#REMOVE_TIMES, {
+            'from': from,
+            'to': to,
+            'date': date,
+            'subject': encodeURIComponent(subjects),
+        });
+    }
+
+    /**
+     * 
+     * @param {*} from 
+     * @param {*} to 
+     * @param {*} date 
+     * @param {*} subject array of subjects 
+     */
+    static async SelectTimes(from, to, date, subject)
+    {
+        var subjects = JSON.stringify(subject);
+
+        await APIController.Post(this.#MODULE, this.#SELECT_TIMES, {
+            'from': from,
+            'to': to,
+            'date': date,
+            'subject': encodeURIComponent(subjects),
+        });
+    }
+
+    /**
+     * Set time for specific date and following weeks
+     * @param {*} from 
+     * @param {*} to 
+     * @param {*} date 
+     * @param {*} subject array of subjects 
+     * @param {*} period how many weeks from date (is treated as start date) will be affected
+     */
+    static async SetTimePeriodicly(from, to, date, subject, period)
+    {
+        var subjects = JSON.stringify(subject);
+
+        await APIController.Post(this.#MODULE, this.#SET_TIMES_PERIODICLY, {
+            'from': from,
+            'to': to,
+            'date': date,
+            'subject': encodeURIComponent(subjects),
+            'period': period,
+        });
+    }
+
+    /**
+     * Gets all subjects this teacher can teach.
+     * @returns json object
+     */
+    static async GetSubjects()
+    {
+        var res = await APIController.Get(this.#MODULE, this.#GET_SUBJECTS);
+
+        return JSON.parse(res);
+    }
+
+    /**
+     * Return all available times for this teacher for specific day
+     * @param {*} date 
+     * @returns JSON object
+     */
+    static async GetDayTimes(date, id = 'logged')
+    {
+        var res = await APIController.Get(this.#MODULE, this.#GET_DATE_TIMES, { 'date': date, 'id': id});
+
+        return JSON.parse(res);
+    }
+}
+
+export default TeacherPortal;

package/modules/TeacherProfiles.js

@@ -0,0 +1,47 @@
+import APIController from "./../apiController";
+import TeacherProfile from "./../objects/TeacherProfile";
+
+class TeacherProfiles
+{
+    static #MODULE = "TeacherProfiles";
+
+    static #GET_PROFILES = "GetProfiles";
+
+    
+    /**
+     * Retrive all public teacher profiles
+     * 
+     * @returns teachers public profiles as array
+     */
+    static async GetProfiles()
+    {
+        var profiles =  await APIController.Get(this.#MODULE, this.#GET_PROFILES);
+        
+        var parsedProfiles;
+        try
+        {
+            parsedProfiles = JSON.parse(profiles);
+        }
+        catch
+        {
+            return null;
+        }
+        
+        var profilesArray = [];
+
+        for (const [key, value] of Object.entries(parsedProfiles))
+        {
+            var profile = new TeacherProfile();
+
+            profile.Name = value['Name'];
+            profile.Bio = value['Bio'];
+            profile.PhotoPath = value['PhotoPath'];
+
+            profilesArray[key] = profile;
+        }
+
+        return profilesArray;
+    }
+}
+
+export default TeacherProfiles;

package/objects/Course.js

@@ -0,0 +1,26 @@
+class Course 
+{
+    Name;
+    NameRaw;
+    School;
+    Price;
+    PriceBeforeSale = -1;
+    IsSaled = false;
+    CreditPrice;
+    ID;
+    Day;
+    /**
+     * as string in hh:mm
+     */
+    Time;
+    Length;
+    /**
+     * Array of lesson dates as dd/mm/YYYY
+     */
+    Lessons;
+    Capacity;
+    Item;
+    Subject;
+}
+
+export default Course;

package/objects/CourseReservation.js

@@ -0,0 +1,10 @@
+class CourseReservation
+{
+    FirstName;
+    LastName;
+    CourseId;
+    Email;
+    TeacherId;
+}
+
+export default CourseReservation;

package/objects/Customer.js

@@ -0,0 +1,9 @@
+class Customer
+{
+    FirstName;
+    LastName;
+    Email;
+    ID;
+}
+
+export default Customer;

package/objects/Enums.js

@@ -0,0 +1,38 @@
+const BookReturn = {
+    SUCCESS: 0,
+    NO_TEACHER_AVAILABLE: 1,
+    ERROR: 2,
+    BAD_RESERVATION: 3,
+}
+
+const AuthResult = {
+    Authenticated: 0,
+    EmailUsed: 1,
+    ConnectionError: 2,
+    MissingInfo: 3,
+    WrongPassword: 4,
+    Error: 5,
+}
+
+const PaymentType = {
+    Stripe: 0,
+    Credits: 1,
+}
+
+const DeviceOS = {
+    WindowsPhone: 0,
+    Android: 1,
+    iOS: 2,
+    Desktop: 3,
+}
+
+const PasswordChange = {
+    Changed: 0,
+    NotAuthenticated: 1,
+    NotAuthorized: 2,
+}
+
+const R_KEYs = {
+    r_key_test: 'r_key_test',
+    r_key_live: 'r_key_live'
+}

package/objects/Reservation.js

@@ -0,0 +1,28 @@
+class Reservation
+{
+    Date;
+    StartTime;
+    Subject;
+    TeacherId;
+    Note;
+    FirstName;
+    LastName;
+    Email;
+    ID;
+
+    IsValid()
+    {
+        if (this.Date == null       ||
+            this.StartTime == null  ||
+            this.Subject == null    ||
+            this.Note == null       ||
+            this.FirstName == null  ||
+            this.LastName == null   ||
+            this.Email == null)
+                return false;
+
+        return true;
+    }
+}
+
+export default Reservation;

package/objects/Subject.js

@@ -0,0 +1,16 @@
+class Subject
+{
+    Name;
+    NameRaw;
+    Level;
+    Description;
+    Price;
+    PriceBeforeSale = -1;
+    IsSaled = false;
+    CreditPrice;
+    IconPath;
+    ID;
+    Item;
+}
+
+export default Subject

package/objects/Teacher.js

@@ -0,0 +1,12 @@
+class Teacher
+{
+   Name;
+   Email;
+   ZoomMeeting;
+   ID;
+   TeachedLessons;
+   Admin;
+   BitmojiURL;
+}
+
+export default Teacher;

package/objects/TeacherProfile.js

@@ -0,0 +1,8 @@
+class TeacherProfile
+{
+    Name;
+    Bio;
+    PhotoPath;
+}
+
+export default TeacherProfile;

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@itutoring/itutoring_application_js_api",
+  "version": "1.0.0",
+  "description": "Javascript API for iTutoring Application",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/iTutoring-s-r-o/iTutoring_Application_API-js"
+  },
+  "keywords": [
+    "api"
+  ],
+  "author": "Tadeas Kaba",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/iTutoring-s-r-o/iTutoring_Application_API-js/issues"
+  },
+  "homepage": "https://github.com/iTutoring-s-r-o/iTutoring_Application_API-js#readme"
+}