feat: helper functions

src/api.ts

@@ -0,0 +1,55 @@
+/**
+ * Helper functions for requesting individual students instead of making a whole client
+ * Using a client should be prefered over performance reasons
+ */
+import { ClasschartsClient } from '.'
+import {
+    ActivityResponse,
+    BehaviourResponse,
+    GetActivityOptions,
+    GetBehaviourOptions,
+    GetHomeworkOptions,
+    GetLessonsOptions,
+    HomeworksResponse,
+    LessonsResponse,
+    Student,
+} from './types'
+export async function getStudentInfo(
+    studentCode: string,
+    dateOfBirth: string | null
+): Promise<Student> {
+    const client = new ClasschartsClient(studentCode, dateOfBirth)
+    return await client.getStudentInfo()
+}
+export async function getActivity(
+    studentCode: string,
+    dateOfBirth: string | null,
+    options: GetActivityOptions | null
+): Promise<ActivityResponse> {
+    const client = new ClasschartsClient(studentCode, dateOfBirth)
+    return await client.getActivity(options)
+}
+export async function getBehaviour(
+    studentCode: string,
+    dateOfBirth: string | null,
+    options: GetBehaviourOptions | null
+): Promise<BehaviourResponse> {
+    const client = new ClasschartsClient(studentCode, dateOfBirth)
+    return await client.getBehaviour(options)
+}
+export async function listHomeworks(
+    studentCode: string,
+    dateOfBirth: string | null,
+    options: GetHomeworkOptions | null
+): Promise<HomeworksResponse> {
+    const client = new ClasschartsClient(studentCode, dateOfBirth)
+    return await client.listHomeworks(options)
+}
+export async function getLessons(
+    studentCode: string,
+    dateOfBirth: string | null,
+    options: GetLessonsOptions
+): Promise<LessonsResponse> {
+    const client = new ClasschartsClient(studentCode, dateOfBirth)
+    return await client.getLessons(options)
+}

src/client.ts

@@ -11,8 +11,11 @@ import {
     HomeworksResponse,
     LessonsResponse,
     Student,
-} from '../types'
+} from './types'
 import { API_BASE, BASE_URL } from './consts'
+/**
+ * The base client
+ */
 export class ClasschartsClient {
     public studentCode = ''
     public dateOfBirth = ''
@@ -20,7 +23,12 @@ export class ClasschartsClient {
     public studentName = ''
     private authCookies: Array<string> | undefined
     private sessionId = ''
-    constructor(studentCode: unknown, dateOfBirth: unknown) {
+    /**
+     *
+     * @param studentCode Classcharts student code
+     * @param dateOfBirth Student's date of birth
+     */
+    constructor(studentCode: string, dateOfBirth: string | null) {
         this.studentCode = String(studentCode)
         this.dateOfBirth = String(dateOfBirth)
     }
@@ -48,8 +56,10 @@ export class ClasschartsClient {
         }
         return responseJSON.data
     }
-
-    async init() {
+    /**
+     * Initialises the client and authenticates with classcharts
+     */
+    async init(): Promise<void> {
         if (!this.studentCode) throw new Error('Student Code not inputted')
         const formData = new URLSearchParams()
         formData.append('_method', 'POST')
@@ -82,6 +92,10 @@ export class ClasschartsClient {
         this.studentId = user.id
         this.studentName = user.name
     }
+    /**
+     * Gets general information about the logged in student
+     * @returns Student object
+     */
     async getStudentInfo(): Promise<Student> {
         if (!this.authCookies) throw new Error('Not authenticated')
         const data = await this.makeAuthedRequest(API_BASE + '/ping', {
@@ -90,6 +104,11 @@ export class ClasschartsClient {
         })
         return data?.user
     }
+    /**
+     * Get's the logged in student's general activity
+     * @param options GetActivityOptions
+     * @returns Activity data
+     */
     async getActivity(
         options: GetActivityOptions | null
     ): Promise<ActivityResponse> {
@@ -103,6 +122,11 @@ export class ClasschartsClient {
             }
         )
     }
+    /**
+     * Gets the logged in students behaviour points
+     * @param options GetBehaviourOptions
+     * @returns Array of behaviour points
+     */
     async getBehaviour(
         options: GetBehaviourOptions | null
     ): Promise<BehaviourResponse> {
@@ -117,6 +141,11 @@ export class ClasschartsClient {
             }
         )
     }
+    /**
+     * Gets a list of the logged in student's homeworks
+     * @param options GetHomeworkOptions
+     * @returns Array of homeworks
+     */
     async listHomeworks(
         options: GetHomeworkOptions | null
     ): Promise<HomeworksResponse> {
@@ -142,6 +171,11 @@ export class ClasschartsClient {
         }
         return data
     }
+    /**
+     * Gets the logged in student's lessons for a day
+     * @param options GetLessonsOptions
+     * @returns Array of lessons
+     */
     async getLessons(options: GetLessonsOptions): Promise<LessonsResponse> {
         if (!this.authCookies) throw new Error('Not authenticated')
         if (!options?.date) throw new Error('No date specified')

src/index.ts

@@ -1 +1,2 @@
 export * from './client'
+export * from './api'

src/release.ts

@@ -22,14 +22,6 @@ function main() {
         __dirname + '/version.txt',
         Buffer.from(sourceObj.version, 'utf-8')
     )
-    try {
-        fs.mkdirSync(__dirname + '/types/')
-    } catch {}
-
-    fs.copyFileSync(
-        __dirname + '/../types/index.d.ts',
-        __dirname + '/types/index.d.ts'
-    )
     fs.copyFileSync(__dirname + '/../.npmignore', __dirname + '/.npmignore')
 }
 

src/types.d.ts

@@ -51,10 +51,10 @@ export interface ActivityResponse {
     timeline: Array<ActivityTimelinePoint>
     positiveReasons: Record<string, string>
     negative_reasons: Record<string, string>
-    other_positive: Array
-    other_negative: Array
-    other_positive_count: Array
-    other_negative_count: Array
+    other_positive: Array<any>
+    other_negative: Array<any>
+    other_positive_count: Array<any>
+    other_negative_count: Array<any>
 }
 export interface GetBehaviourOptions {
     from: string | undefined
@@ -114,11 +114,11 @@ export interface Homework {
         allow_attachments: string
         first_seen_date: string
         last_seen_date: string
-        attachments: Array
+        attachments: Array<any>
         has_feedback: boolean
     }
-    validated_links: Array
-    validated_attachments: Array
+    validated_links: Array<any>
+    validated_attachments: Array<any>
 }
 export type HomeworksResponse = Array<Homework>
 export interface GetLessonsOptions {

tsconfig.json

@@ -87,6 +87,6 @@
 		// "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
 		/* Completeness */
 		// "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
-		"skipLibCheck": true /* Skip type checking all .d.ts files. */
+		// "skipLibCheck": true /* Skip type checking all .d.ts files. */
 	}
 }