@itutoring/itutoring_application_js_api 1.0.0

package/modules/Payments.js

@@ -0,0 +1,52 @@
+import APIController from "./../apiController";
+
+class Payments
+{
+    /**
+    * Respective module name for this class
+    */
+    static #MODULE = "Payments";
+
+    // All method names
+    static #PURCHASE = "Purchase";
+    static #VALIDATE_PURCHASE = "ValidatePurchase";
+
+    /**
+     * Purchase specific product. After calling you'll be redirected depending on the result to success or cancel (failed) url
+     * @param {*} product product name as defined in php such as HOUR_LESSON
+     * @param {*} type payment type (credits, card), use PaymentType enum
+     * @param {*} successUrl
+     * @param {*} cancelUrl 
+     * @param {*} successUrlParams  additional query string to success url - optional
+     * @returns if stripe payment; returns stripe page url
+     */
+    static async Purchase(product, isSaled, type, successUrl, cancelUrl, successUrlParams = "")
+    {
+        var url = await APIController.Post(this.#MODULE, this.#PURCHASE, {
+            'product': product,
+            'saled': APIController.BoolToInt(isSaled),
+            'type': type,
+            'successUrl': successUrl,
+            'cancelUrl': cancelUrl,
+            'successUrlParams': successUrlParams,
+        });
+
+        return url;
+    }
+
+    /**
+     * Call on success page after purchase to mark the payment as successful.
+     *  
+     * Will return false if is already marked.
+     * @param {*} id 
+     * @returns bool
+     */
+    static async ValidatePurchase(transactionId)
+    {
+        var res = await APIController.Get(this.#MODULE, this.#VALIDATE_PURCHASE, { 'id': transactionId });
+
+        return APIController.IntToBool(res);
+    }
+}
+
+export default Payments;

package/modules/ReservationSystem.js

@@ -0,0 +1,238 @@
+import APIController from "./../apiController";
+import Reservation from "./../objects/Reservation";
+
+class ReservationSystem
+{
+    /**
+    * Respective module name for this class
+    */
+    static #MODULE = "ReservationSystem";
+
+    // All method names
+    static #GET_AVAILABILITY_FOR_DAY = "GetAvailabilityForDay";
+    static #GET_AVAILABILITY_FOR_MONTH = "GetAvailabilityForMonth";
+    static #IS_TIME_AVAILABLE = "IsTimeAvailable";
+    static #IS_DAY_AVAILABLE = "IsDayAvailable";
+    static #RESERVE_TIME = "ReserveTime";
+    static #BOOK = "Book";
+    static #ORDER_TIMEOUT = "OrderTimeout";
+    static #CONFIRM_RESERVATION = "ConfirmReservation";
+    static #GET_RESERVATION = "GetReservation";
+    static #IS_RESERVATION_PAID = "IsReservationPaid";
+    static #MARK_RESERVATION_PAID = "MarkReservationPaid";
+    static #RETRIVE_ORDER_ID = "RetriveOrderID";
+
+    /**
+     * Returns availability for specific day and subject
+     * @param {*} date 
+     * @param {*} subject 
+     * @returns float in range 0...1
+     */
+    static async GetAvailabilityForDay(date, subject)
+    {
+        var data = await APIController.Get(this.#MODULE, this.#GET_AVAILABILITY_FOR_DAY, { 'date': date, 'subject': subject });
+
+        return parseFloat(data);
+    }
+
+    /**
+     * Get how much each day in month is free.
+     * 
+     * @param {*} month month id (starts with 0 ends 11)
+     * @param {*} year 
+     * @param {*} subject subject id
+     * @returns all values (in percent 0...1) by day ascending (1st .... 31st/30rd) as JSON string.
+     */
+    static async GetAvailabilityForMonth(month, year, subject)
+    {
+        var data = await APIController.Get(this.#MODULE, this.#GET_AVAILABILITY_FOR_MONTH,
+            {
+                'month': month,
+                'year': year,
+                'subject': subject,
+            });
+
+        return JSON.parse(data);
+    }
+
+    /**
+     * Check if specific start time is availiable.
+     * @param {*} date 
+     * @param {*} subject 
+     * @param {*} startTime 
+     * @param {*} lessons number of lessons (1 = 60 mins, 2 = 2x60 mins)
+     * @returns bool
+     */
+    static async IsTimeAvailable(date, subject, startTime, lessons = 1)
+    {
+        var data = await APIController.Get(this.#MODULE, this.#IS_TIME_AVAILABLE, { 'date': date, 'subject': subject, 'start': startTime, "lessons": lessons });
+
+        return APIController.IntToBool(data);
+    }
+
+    /**
+     * Get all available times for specific day and subject
+     * @param {*} date 
+     * @param {*} subject 
+     * @param {*} lessons number of lessons (1 = 60 mins, 2 = 2x60 mins)
+     * @returns float array of available times
+     */
+    static async IsDayAvailable(date, subject, lessons = 1)
+    {
+        var availableTimes = await APIController.Get(this.#MODULE, this.#IS_DAY_AVAILABLE, { 'date': date, 'subject': subject, "lessons": lessons });
+
+        return JSON.parse(availableTimes);
+    }
+
+    /**
+     * Reserve time during creating order.
+     * 
+     * Reserved time will have unique token.
+     * 
+     * Is not needed to pass teacherId if you already calld GetTeacherForLesson. So teacher is already chosen and saved in session.
+     * @param {*} date 
+     * @param {*} startTime 
+     * @param {*} subject 
+     * @param {*} lessons 
+     * @param {*} teacherId
+     */
+    static async ReserveTime(date, startTime, subject, lessons, teacherId = "session")
+    {
+        var result = await APIController.Get(this.#MODULE, this.#RESERVE_TIME, {
+            'date': date,
+            'start': startTime,
+            'subject': subject,
+            'lessons': lessons,
+            'teacher': teacherId,
+        });
+
+        return parseInt(result);
+    }
+
+    /**
+     * Keep teacherId in reservation object null if you chosen teacher before
+     * @param {*} reservation 
+     * @param {*} lessons 
+     * @returns int (BookReturn)
+     */
+    static async Book(reservation, lessons)
+    {
+        if (!reservation.IsValid())
+        {
+            throw ("Reservation is not valid");
+        }
+
+        var reservationJSON = JSON.stringify(reservation);
+
+        var result = await APIController.Post(this.#MODULE, this.#BOOK, {
+            'reservation': encodeURIComponent(reservationJSON),
+            'lessons': lessons,
+        });
+
+        return result;
+    }
+
+    /**
+     * Return if reserved time in DB is still present.
+     * 
+     * Need to be called after reserving time, so token is generated.
+     * 
+     * Should be called before book to check that time.
+     * @returns true if is timeouted(time is deleted) , false if time is still there
+     */
+    static async OrderTimeout()
+    {
+        var res = await APIController.Get(this.#MODULE, this.#ORDER_TIMEOUT);
+
+        return APIController.IntToBool(res);
+    }
+
+    /**
+     * Send confirmation email to teacher and customer.
+     * @param {*} resend If true, the last send confirmation email will be resend. (just for the same session)
+     * @returns True if succeded
+     */
+    static async ConfirmReservation(resend = false)
+    {
+        var res = await APIController.Get(this.#MODULE, this.#CONFIRM_RESERVATION, { 'resend': APIController.BoolToInt(resend) });
+
+        return APIController.IntToBool(res);
+    }
+
+    /**
+     * Get reservation by id
+     * @param {*} id reservation id
+     * @returns Reservation object
+     */
+    static async GetReservation(id)
+    {
+        var res = await APIController.Get(this.#MODULE, this.#GET_RESERVATION, { 'id': id });
+
+        try
+        {
+            JSON.parse(res)
+        }
+        catch
+        {
+            return null;
+        }
+
+        var reservationArray = JSON.parse(res);
+
+        var reservation = new Reservation();
+        reservation.Date = reservationArray['Date'];
+        reservation.StartTime = reservationArray['StartTime'];
+        reservation.Subject = reservationArray['Subject'];
+        reservation.TeacherId = reservationArray['TeacherId'];
+        reservation.Note = reservationArray['Note'];
+        reservation.FirstName = reservationArray['FirstName'];
+        reservation.LastName = reservationArray['LastName'];
+        reservation.Email = reservationArray['Email'];
+
+        return reservation;
+    }
+
+    /**
+     * Check if reservation has been paid
+     * @param {*} id reservation id
+     * @returns 
+     */ Bool
+    static async IsReservationPaid(id)
+    {
+        var res = await APIController.Get(this.#MODULE, this.#IS_RESERVATION_PAID, { 'id': id })
+
+        return APIController.IntToBool(res);
+    }
+
+    /**
+     * Will mark reservation as paid. Must provide transaction id for that reservation to confirm that it was paid.
+     * @param {*} reservationId 
+     * @param {*} transactionId 
+     * @returns bool
+     */
+    static async MarkReservationPaid(reservationId, transactionId)
+    {
+        var res = await APIController.Get(this.#MODULE, this.#MARK_RESERVATION_PAID, {
+            'reservationId': reservationId,
+            'transactionId': transactionId,
+        });
+
+        return APIController.IntToBool(res);
+    }
+
+    /**
+     * Get latest order id. Works for both Lessons and courses.
+     * 
+     * Book function must be called before. ID is stored in session.
+     * 
+     * @returns orderId
+     */
+    static async RetriveOrderID()
+    {
+        var id = await APIController.Get(this.#MODULE, this.#RETRIVE_ORDER_ID);
+
+        return id;
+    }
+}
+
+export default ReservationSystem;

package/modules/SubjectManager.js

@@ -0,0 +1,112 @@
+import Subject from "./../objects/Subject";
+import APIController from "./../apiController";
+import Course from "./../objects/Course";
+
+class SubjectManager
+{
+    /**
+     * Respective module name for this class
+     */
+    static #MODULE = "SubjectManager";
+
+    // All method names
+    static #GET_ALL_AVAILABLE_SUBJECTS = "GetAllAvailableSubjects";
+    static #GET_ALL_AVAILABLE_COURSES = "GetAllAvailableCourses";
+
+    // Cache keys
+    static #SUBJECTS_CACHE_KEY = "json_subjects_c_k";
+    static #COURSES_CACHE_KEY = "json_courses_c_k";
+
+    /**
+     * 
+     * @returns Array (Subject[id]) of all available subjects as array of Subject objects. Key is id of subject.
+     */
+    static async GetAllAvailableSubjects(requestReload = false)
+    {
+        var data;
+
+        /*if (APICache.IsCached(this.#SUBJECTS_CACHE_KEY) && !requestReload)
+        {
+            data = APICache.Retrive(this.#SUBJECTS_CACHE_KEY);
+        }
+        else
+        {
+            data = await APIController.Get(this.#MODULE, this.#GET_ALL_AVAILABLE_SUBJECTS);
+            APICache.Cache(this.#SUBJECTS_CACHE_KEY, data);
+        }*/
+
+        data = await APIController.Get(this.#MODULE, this.#GET_ALL_AVAILABLE_SUBJECTS);
+
+        var dataArray = JSON.parse(data);
+
+        var availableSubjects = [];
+
+        for (const [key, value] of Object.entries(dataArray))
+        {
+            var subject = new Subject();
+            subject.CreditPrice = value['CreditPrice'];
+            subject.Description = value['Description'];
+            subject.ID = value['ID'];
+            subject.IconPath = value['IconPath'];
+            subject.Name = value['Name'];
+            subject.Price = value['Price'];
+            subject.NameRaw = value['NameRaw'];
+            subject.Level = value['Level'];
+            subject.Item = value['Item'];
+            subject.PriceBeforeSale = value['PriceBeforeSale'];
+            subject.IsSaled = value['IsSaled'];
+
+            availableSubjects[subject.ID] = subject;
+        }
+
+        return availableSubjects;
+    }
+
+    static async GetAllAvailableCourses(requestReload = false)
+    {
+        var data;
+
+        /*if (APICache.IsCached(this.#COURSES_CACHE_KEY) && !requestReload)
+        {
+            data = APICache.Retrive(this.#COURSES_CACHE_KEY);
+        }
+        else
+        {
+            data = await APIController.Get(this.#MODULE, this.#GET_ALL_AVAILABLE_COURSES);
+            APICache.Cache(this.#COURSES_CACHE_KEY, data);
+        }*/
+
+        data = await APIController.Get(this.#MODULE, this.#GET_ALL_AVAILABLE_COURSES);
+
+        var dataArray = JSON.parse(data);
+
+        var availableCourses = [];
+
+        for (const [key, value] of Object.entries(dataArray))
+        {
+            var course = new Course();
+
+            course.Name = value['Name'];
+            course.NameRaw = value['NameRaw'];
+            course.School = value['School'];
+            course.Price = value['Price'];
+            course.CreditPrice = value['CreditPrice'];
+            course.ID = value['ID'];
+            course.Day = value['Day'];
+            course.Time = value['Time'];
+            course.Length = value['Length'];
+            course.Lessons = value['Lessons'];
+            course.Capacity = value['Capacity'];
+            course.Item = value['Item'];
+            course.Subject = value['Subject'];
+            course.PriceBeforeSale = value['PriceBeforeSale'];
+            course.IsSaled = value['IsSaled'];
+
+            availableCourses[course.ID] = course;
+        }
+
+        return availableCourses;
+    }
+}
+
+export default SubjectManager;

package/modules/TeacherAuth.js

@@ -0,0 +1,75 @@
+import APIController from "./../apiController";
+
+class TeacherAuth
+{
+   /**
+* Respective module name for this class
+*/
+   static #MODULE = "TeacherAuth";
+
+   // All method names
+   static #LOGIN = "Login";
+   static #REGISTER = "Register";
+   static #IS_AUTHENTICATED = "IsAuthenticated";
+   static #CHANGE_PASSWOD = "ChangePassword";
+
+   /**
+    * 
+    * @param {*} email 
+    * @param {*} password 
+    * @returns int (AuthResult)
+    */
+   static async Login(email, password)
+   {
+      var res = await APIController.Post(this.#MODULE, this.#LOGIN, {
+         'email': email,
+         'pass': password,
+      })
+
+      return res;
+   }
+
+   /**
+    * Change current password
+    * @param {*} oldPass is required to authorize user
+    * @param {*} newPass 
+    * @returns int (PasswordChange enum)
+    */
+   static async ChangePassword(oldPass, newPass)
+   {
+      var res = await APIController.Post(this.#MODULE, this.#CHANGE_PASSWOD, {
+         'oldPass': oldPass,
+         'newPass': newPass,
+      });
+
+      return res;
+   }
+
+   /**
+    * 
+    * @param {*} email 
+    * @param {*} password 
+    * @returns int (AuthResult)
+    */
+   static async Register(email, password, name, meetingLink, subjects)
+   {
+      var res = await APIController.Post(this.#MODULE, this.#REGISTER, {
+         'email': email,
+         'pass': password,
+         'name': name,
+         'meetingLink': meetingLink,
+         'subjects': subjects,
+      });
+
+      return res;
+   }
+
+   static async IsAuthenticated()
+   {
+      var res = await APIController.Get(this.#MODULE, this.#IS_AUTHENTICATED);
+
+      return APIController.IntToBool(res);
+   }
+}
+
+export default TeacherAuth;

package/modules/TeacherManager.js

@@ -0,0 +1,72 @@
+import APIController from "./../apiController";
+import Teacher from "./../objects/Teacher";
+
+class TeacherManager
+{
+    /**
+    * Respective module name for this class
+    */
+    static #MODULE = "TeacherManager";
+
+    // All method names
+    static #GET_TEACHER_FOR_LESSON = "GetTeacherForLesson";
+    static #GET_ALL_TEACHERS = "GetAllTeachers";
+    static #UPDATE_SUBJECT_TIMES = "UpdateSubjectTimes";
+
+    /**
+     * Find and choose available teacher for your time.
+     * Teacher will be stored in session on server.
+     * @param {*} date 
+     * @param {*} startTime 
+     * @param {*} subject 
+     * @param {*} lessons 
+     * @returns true if teacher was found, false if no teacher available
+     */
+    static async GetTeacherForLesson(date, startTime, subject, lessons)
+    {
+        var result = await APIController.Get(this.#MODULE, this.#GET_TEACHER_FOR_LESSON, {
+            'date': date,
+            'start': startTime,
+            'subject': subject,
+            'lessons': lessons,
+        });
+
+        return APIController.IntToBool(result);
+    }
+
+    static async GetAllTeachers()
+    {
+        var teachers = await APIController.Get(this.#MODULE, this.#GET_ALL_TEACHERS);
+        
+        var teachersArray = JSON.parse(teachers);
+
+        var teachersClasses = [];
+
+        for (const[key, value] of Object.entries(teachersArray))
+        {
+            var teacher = new Teacher;
+
+            teacher.Name = value['Name'];
+            teacher.Email = value['Email'];
+            teacher.ZoomMeeting = value['ZoomMeeting'];
+            teacher.ID = value['ID'];
+            teacher.TeachedLessons = value['TeachedLessons'];
+            teacher.Admin = APIController.IntToBool(value['Admin']);
+
+            teachersClasses[teacher.ID] = teacher;
+        }
+
+        return teachersClasses;
+    }
+
+    static async UpdateSubjectTimes(teacherId)
+    {
+        var res = await APIController.Get(this.#MODULE, this.#UPDATE_SUBJECT_TIMES, {
+            'teacherId': teacherId,
+        });
+
+        return APIController.IntToBool(res);
+    }
+}
+
+export default TeacherManager;