mirror of
https://github.com/classchartsapi/classcharts-api-js.git
synced 2026-05-14 11:58:13 +00:00
feat: parent support
This commit is contained in:
ChrisPhillips-cminion
James Cook
parent
928a9f76f5
commit
ab73bd92cd
39 changed files with 3983 additions and 120 deletions
|
|
@ -15,30 +15,28 @@ import {
|
|||
LessonsResponse,
|
||||
Student,
|
||||
} from "./types";
|
||||
import { API_BASE, BASE_URL } from "./consts";
|
||||
|
||||
/**
|
||||
* The base client
|
||||
*/
|
||||
export class ClasschartsClient {
|
||||
public studentCode = "";
|
||||
public dateOfBirth = "";
|
||||
public studentId = 0;
|
||||
public studentName = "";
|
||||
private authCookies: Array<string> | undefined;
|
||||
private sessionId = "";
|
||||
protected studentId = 0;
|
||||
protected studentName = "";
|
||||
protected authCookies: Array<string> | undefined;
|
||||
protected sessionId = "";
|
||||
protected API_BASE = "";
|
||||
/**
|
||||
*
|
||||
* @param studentCode Classcharts student code
|
||||
* @param dateOfBirth Student's date of birth
|
||||
* @param API_BASE Base API URL, this is different depending if its called as a parent or student
|
||||
*/
|
||||
constructor(studentCode: string, dateOfBirth?: string) {
|
||||
this.studentCode = String(studentCode);
|
||||
this.dateOfBirth = String(dateOfBirth);
|
||||
constructor(API_BASE: string) {
|
||||
this.API_BASE = API_BASE
|
||||
}
|
||||
public async makeAuthedRequest(
|
||||
path: string,
|
||||
options: Omit<RequestOptions, "origin" | "path">
|
||||
) {
|
||||
|
||||
if (!this.authCookies) throw new Error("Not authenticated");
|
||||
const requestOptions: Omit<RequestOptions, "origin" | "path"> = {
|
||||
...options,
|
||||
|
|
@ -47,7 +45,10 @@ export class ClasschartsClient {
|
|||
authorization: "Basic " + this.sessionId,
|
||||
},
|
||||
};
|
||||
|
||||
|
||||
const request = await Undici.request(path, requestOptions);
|
||||
|
||||
let responseJSON;
|
||||
try {
|
||||
responseJSON = await request.body.json();
|
||||
|
|
@ -55,63 +56,24 @@ export class ClasschartsClient {
|
|||
throw new Error("Invalid JSON response recieved");
|
||||
}
|
||||
if (responseJSON.success == 0) {
|
||||
|
||||
throw new Error(responseJSON.error);
|
||||
}
|
||||
|
||||
return responseJSON.data;
|
||||
}
|
||||
/**
|
||||
* Initialises the client and authenticates with classcharts
|
||||
*/
|
||||
async login(): Promise<void> {
|
||||
if (!this.studentCode) throw new Error("Student Code not inputted");
|
||||
const formData = new URLSearchParams();
|
||||
formData.append("_method", "POST");
|
||||
formData.append("code", this.studentCode.toUpperCase());
|
||||
formData.append("dob", this.dateOfBirth);
|
||||
formData.append("remember_me", "1");
|
||||
formData.append("recaptcha-token", "no-token-avaliable");
|
||||
const request = await Undici.request(BASE_URL + "/student/login", {
|
||||
method: "POST",
|
||||
body: formData.toString(),
|
||||
headers: {
|
||||
"Content-Type": "application/x-www-form-urlencoded",
|
||||
},
|
||||
});
|
||||
if (request.statusCode != 302 || !request.headers["set-cookie"])
|
||||
throw new Error("Unauthenticated: Classcharts returned an error");
|
||||
const cookies = request.headers["set-cookie"];
|
||||
for (let i = 0; i < cookies.length; i++) {
|
||||
cookies[i] = cookies[i].substring(0, cookies[i].indexOf(";"));
|
||||
}
|
||||
this.authCookies = cookies;
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
let sessionID: any = decodeURI(cookies[2])
|
||||
.replace(/%3A/g, ":")
|
||||
.replace(/%2C/g, ",");
|
||||
sessionID = JSON.parse(
|
||||
sessionID.substring(sessionID.indexOf("{"), sessionID.length)
|
||||
);
|
||||
this.sessionId = sessionID.session_id;
|
||||
const user = await this.getStudentInfo();
|
||||
this.studentId = user.id;
|
||||
this.studentName = user.name;
|
||||
}
|
||||
/**
|
||||
* @deprecated Use .login() instead
|
||||
*/
|
||||
async init(): Promise<void> {
|
||||
console.warn(".init() is deprecated, please use .login()");
|
||||
await this.login();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Gets general information about the logged in student
|
||||
* @returns Student object
|
||||
*/
|
||||
async getStudentInfo(): Promise<Student> {
|
||||
const data = await this.makeAuthedRequest(API_BASE + "/ping", {
|
||||
const data = await this.makeAuthedRequest(this.API_BASE + "/ping", {
|
||||
method: "POST",
|
||||
body: "include_date=true",
|
||||
body: "include_data=true",
|
||||
});
|
||||
|
||||
return data?.user;
|
||||
}
|
||||
/**
|
||||
|
|
@ -125,12 +87,15 @@ export class ClasschartsClient {
|
|||
options?.to && params.append("to", options?.to);
|
||||
options?.last_id && params.append("last_id", options?.last_id);
|
||||
return this.makeAuthedRequest(
|
||||
API_BASE + "/activity/" + this.studentId + "?" + params.toString(),
|
||||
this.API_BASE + "/activity/" + this.studentId + "?" + params.toString(),
|
||||
{
|
||||
method: "GET",
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Gets the logged in students behaviour points
|
||||
* @param options GetBehaviourOptions
|
||||
|
|
@ -143,7 +108,7 @@ export class ClasschartsClient {
|
|||
options?.from && params.append("from", options?.from);
|
||||
options?.to && params.append("to", options?.to);
|
||||
return await this.makeAuthedRequest(
|
||||
API_BASE + "/behaviour/" + this.studentId + "?" + params.toString(),
|
||||
this.API_BASE + "/behaviour/" + this.studentId + "?" + params.toString(),
|
||||
{
|
||||
method: "GET",
|
||||
}
|
||||
|
|
@ -164,7 +129,7 @@ export class ClasschartsClient {
|
|||
options?.fromDate && params.append("from", String(options?.fromDate));
|
||||
options?.toDate && params.append("to", String(options?.toDate));
|
||||
const data: Array<Homework> = await this.makeAuthedRequest(
|
||||
API_BASE + "/homeworks/" + this.studentId + "?" + params.toString(),
|
||||
this.API_BASE + "/homeworks/" + this.studentId + "?" + params.toString(),
|
||||
{
|
||||
method: "GET",
|
||||
}
|
||||
|
|
@ -178,7 +143,7 @@ export class ClasschartsClient {
|
|||
data[i].description = data[i].description.replace(/ /g, "");
|
||||
data[i].description = data[i].description.trim();
|
||||
}
|
||||
|
||||
console.log(data)
|
||||
return data;
|
||||
}
|
||||
/**
|
||||
|
|
@ -191,7 +156,7 @@ export class ClasschartsClient {
|
|||
const params = new URLSearchParams();
|
||||
params.append("date", String(options?.date));
|
||||
return await this.makeAuthedRequest(
|
||||
API_BASE + "/timetable/" + this.studentId + "?" + params.toString(),
|
||||
this.API_BASE + "/timetable/" + this.studentId + "?" + params.toString(),
|
||||
{
|
||||
method: "GET",
|
||||
}
|
||||
|
|
@ -203,7 +168,7 @@ export class ClasschartsClient {
|
|||
*/
|
||||
async getBadges(): Promise<BadgesResponse> {
|
||||
return await this.makeAuthedRequest(
|
||||
API_BASE + "/eventbadges/" + this.studentId,
|
||||
this.API_BASE + "/eventbadges/" + this.studentId,
|
||||
{
|
||||
method: "GET",
|
||||
}
|
||||
|
|
@ -215,7 +180,7 @@ export class ClasschartsClient {
|
|||
*/
|
||||
async listAnnouncements(): Promise<AnnouncementsResponse> {
|
||||
return await this.makeAuthedRequest(
|
||||
API_BASE + "/announcements/" + this.studentId,
|
||||
this.API_BASE + "/announcements/" + this.studentId,
|
||||
{
|
||||
method: "GET",
|
||||
}
|
||||
|
|
@ -227,7 +192,7 @@ export class ClasschartsClient {
|
|||
*/
|
||||
async getDetentions(): Promise<DetentionsResponse> {
|
||||
return await this.makeAuthedRequest(
|
||||
API_BASE + "/detentions/" + this.studentId,
|
||||
this.API_BASE + "/detentions/" + this.studentId,
|
||||
{
|
||||
method: "GET",
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue