feat: code

.gitignore

@@ -0,0 +1,121 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+.env.production
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+
+src/tests/config.json

package-lock.json

@@ -0,0 +1,66 @@
+{
+	"name": "classcharts-api",
+	"version": "0.0.1",
+	"lockfileVersion": 2,
+	"requires": true,
+	"packages": {
+		"": {
+			"name": "classcharts-api",
+			"version": "0.0.1",
+			"license": "ISC",
+			"dependencies": {
+				"undici": "^4.9.1"
+			},
+			"devDependencies": {
+				"@types/node": "^16.11.6",
+				"typescript": "^4.4.4"
+			}
+		},
+		"node_modules/@types/node": {
+			"version": "16.11.6",
+			"resolved": "https://registry.npmjs.org/@types/node/-/node-16.11.6.tgz",
+			"integrity": "sha512-ua7PgUoeQFjmWPcoo9khiPum3Pd60k4/2ZGXt18sm2Slk0W0xZTqt5Y0Ny1NyBiN1EVQ/+FaF9NcY4Qe6rwk5w==",
+			"dev": true
+		},
+		"node_modules/typescript": {
+			"version": "4.4.4",
+			"resolved": "https://registry.npmjs.org/typescript/-/typescript-4.4.4.tgz",
+			"integrity": "sha512-DqGhF5IKoBl8WNf8C1gu8q0xZSInh9j1kJJMqT3a94w1JzVaBU4EXOSMrz9yDqMT0xt3selp83fuFMQ0uzv6qA==",
+			"dev": true,
+			"bin": {
+				"tsc": "bin/tsc",
+				"tsserver": "bin/tsserver"
+			},
+			"engines": {
+				"node": ">=4.2.0"
+			}
+		},
+		"node_modules/undici": {
+			"version": "4.9.1",
+			"resolved": "https://registry.npmjs.org/undici/-/undici-4.9.1.tgz",
+			"integrity": "sha512-2idBVoUuxp5ByT15DDs3BjmU278D9gr6gDh3tNwOMw8TiHfueq+qHdhHHj8vNIi1UTTmn1cxL2VF3ONry+eS2w==",
+			"engines": {
+				"node": ">=12.18"
+			}
+		}
+	},
+	"dependencies": {
+		"@types/node": {
+			"version": "16.11.6",
+			"resolved": "https://registry.npmjs.org/@types/node/-/node-16.11.6.tgz",
+			"integrity": "sha512-ua7PgUoeQFjmWPcoo9khiPum3Pd60k4/2ZGXt18sm2Slk0W0xZTqt5Y0Ny1NyBiN1EVQ/+FaF9NcY4Qe6rwk5w==",
+			"dev": true
+		},
+		"typescript": {
+			"version": "4.4.4",
+			"resolved": "https://registry.npmjs.org/typescript/-/typescript-4.4.4.tgz",
+			"integrity": "sha512-DqGhF5IKoBl8WNf8C1gu8q0xZSInh9j1kJJMqT3a94w1JzVaBU4EXOSMrz9yDqMT0xt3selp83fuFMQ0uzv6qA==",
+			"dev": true
+		},
+		"undici": {
+			"version": "4.9.1",
+			"resolved": "https://registry.npmjs.org/undici/-/undici-4.9.1.tgz",
+			"integrity": "sha512-2idBVoUuxp5ByT15DDs3BjmU278D9gr6gDh3tNwOMw8TiHfueq+qHdhHHj8vNIi1UTTmn1cxL2VF3ONry+eS2w=="
+		}
+	}
+}

package.json

@@ -0,0 +1,22 @@
+{
+	"name": "classcharts-api",
+	"version": "0.0.1",
+	"description": "",
+	"repository": {
+		"url": "https://github.com/jamesatjaminit/"
+	},
+	"main": "dist/index.js",
+	"scripts": {
+		"test": "echo \"Error: no test specified\" && exit 1"
+	},
+	"author": "",
+	"license": "ISC",
+	"dependencies": {
+		"undici": "^4.9.1"
+	},
+	"devDependencies": {
+		"@types/node": "^16.11.6",
+		"typescript": "^4.4.4"
+	},
+	"types": "./types/index.d.ts"
+}

readme.md

@@ -0,0 +1,3 @@
+# Classcharts API
+
+A very WIP client for the classcharts API

src/client.ts

@@ -0,0 +1,117 @@
+import Undici from 'undici'
+import { DisplayDate, Homework, User } from '../types'
+import { API_BASE, BASE_URL } from './consts'
+
+export class ClasschartsClient {
+    public studentCode = ''
+    public dateOfBirth = ''
+    public studentId = 0
+    public studentName = ''
+    private authCookies: Array<string> | undefined
+    private sessionId = ''
+    constructor(studentCode: unknown, dateOfBirth: unknown) {
+        this.studentCode = String(studentCode)
+        this.dateOfBirth = String(dateOfBirth)
+    }
+    async init() {
+        const formData = new URLSearchParams()
+        if (!this.studentCode) throw new Error('Student Code not inputted')
+        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')
+        let 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
+        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
+    }
+
+    /**
+     *
+     * @returns {User}
+     */
+    async getStudentInfo(): Promise<User> {
+        if (!this.authCookies) throw new Error('Not authenticated')
+        const request = await Undici.request(API_BASE + '/ping', {
+            method: 'POST',
+            body: 'include_date=true',
+            headers: {
+                'Content-Type': 'application/x-www-form-urlencoded',
+                Cookie: this.authCookies.join(';'),
+                authorization: 'Basic ' + this.sessionId,
+            },
+        })
+        const data = await request.body.json()
+        return data.data?.user
+    }
+    /**
+     * Gets all the homework from
+     * @param displayDate {DisplayDate}
+     * @param fromDate
+     * @param toDate
+     * @returns {Array<Homework>}
+     */
+    async listHomeworks(
+        displayDate: DisplayDate,
+        fromDate: string,
+        toDate: string
+    ): Promise<Array<Homework>> {
+        if (!this.authCookies) throw new Error('Not authenticated')
+        const params = new URLSearchParams()
+        params.append('display_date', String(displayDate))
+        fromDate && params.append('from', String(fromDate))
+        toDate && params.append('to', String(toDate))
+        const request = await Undici.request(
+            API_BASE + '/homeworks/' + this.studentId + '?' + params.toString(),
+            {
+                method: 'GET',
+                headers: {
+                    Cookie: this.authCookies.join(';'),
+                    authorization: 'Basic ' + this.sessionId,
+                },
+            }
+        )
+        let responseJSON
+        try {
+            responseJSON = await request.body.json()
+        } catch (err) {
+            throw new Error('Invalid JSON response, check your dates')
+        }
+
+        if (responseJSON.success == 0) {
+            throw new Error(responseJSON.error)
+        }
+        let data: Array<Homework> = responseJSON?.data
+        for (let i = 0; i < data.length; i++) {
+            // homework.lesson.replace(/\\/g, '')
+            data[i].description = data[i].description.replace(
+                /(<([^>]+)>)/gi,
+                ''
+            )
+            data[i].description = data[i].description.replace(/&nbsp;/g, '')
+            data[i].description = data[i].description.trim()
+        }
+        return data
+    }
+}

src/consts.ts

@@ -0,0 +1,2 @@
+export const BASE_URL = 'https://www.classcharts.com'
+export const API_BASE = `${BASE_URL}/apiv2student`

src/index.ts

@@ -0,0 +1,3 @@
+import { ClasschartsClient } from './client'
+
+exports.ClasschartsClient = ClasschartsClient

src/tests/test.ts

@@ -0,0 +1,11 @@
+import { ClasschartsClient } from '../client'
+const { code, dob } = require('../../src/tests/config.json')
+async function main() {
+    const client = new ClasschartsClient(code, dob)
+    await client.init()
+    console.log(
+        await client.listHomeworks('due_date', '2021-10-21', '2021-11-27')
+    )
+}
+
+main()

tsconfig.json

@@ -0,0 +1,92 @@
+{
+	"compilerOptions": {
+		/* Visit https://aka.ms/tsconfig.json to read more about this file */
+		/* Projects */
+		// "incremental": true,                              /* Enable incremental compilation */
+		// "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+		// "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
+		// "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
+		// "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+		// "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+		/* Language and Environment */
+		"target": "es5", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+		// "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+		// "jsx": "preserve",                                /* Specify what JSX code is generated. */
+		// "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+		// "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+		// "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
+		// "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+		// "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
+		// "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
+		// "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+		// "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+		/* Modules */
+		"module": "commonjs", /* Specify what module code is generated. */
+		// "rootDir": "./",                                  /* Specify the root folder within your source files. */
+		// "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+		// "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+		// "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+		// "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+		// "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
+		// "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+		// "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+		// "resolveJsonModule": true,                        /* Enable importing .json files */
+		// "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
+		/* JavaScript Support */
+		// "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
+		// "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+		// "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
+		/* Emit */
+		// "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+		// "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+		// "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+		// "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+		// "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
+		"outDir": "dist", /* Specify an output folder for all emitted files. */
+		// "removeComments": true,                           /* Disable emitting comments. */
+		// "noEmit": true,                                   /* Disable emitting files from a compilation. */
+		// "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+		// "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
+		// "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+		// "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+		// "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+		// "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+		// "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+		// "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+		// "newLine": "crlf",                                /* Set the newline character for emitting files. */
+		// "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
+		// "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
+		// "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+		// "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
+		// "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+		/* Interop Constraints */
+		// "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+		// "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+		"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
+		// "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+		"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
+		/* Type Checking */
+		"strict": true, /* Enable all strict type-checking options. */
+		// "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
+		// "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
+		// "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+		// "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
+		// "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+		// "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
+		// "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
+		// "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+		// "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
+		// "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
+		// "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+		// "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+		// "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+		// "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
+		// "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+		// "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
+		// "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+		// "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. */
+	}
+}

types/index.d.ts

@@ -0,0 +1,68 @@
+export interface User {
+    id: number
+    name: string
+    first_name: string
+    last_name: string
+    avatar_url: string
+    display_behaviour: boolean
+    display_parent_behaviour: boolean
+    display_homework: boolean
+    display_rewards: boolean
+    display_detentions: boolean
+    display_report_cards: boolean
+    display_classes: boolean
+    display_announcements: boolean
+    display_attendance: boolean
+    display_attendance_type: string
+    display_attendance_percentage: boolean
+    display_activity: boolean
+    display_mental_health: boolean
+    display_timetable: boolean
+    is_disabled: boolean
+    display_two_way_communications: boolean
+    display_absences: boolean
+    can_upload_attachments: string | null
+    display_event_badges: boolean
+    display_avatars: boolean
+    display_concern_submission: boolean
+    display_custom_fields: boolean
+    pupil_concerns_help_text: string
+    allow_pupils_add_timetable_notes: boolean
+    announcements_count: number
+    messages_count: number
+    pusher_channel_name: string
+    has_birthday: boolean
+    has_new_survey: boolean
+    survey_id: number | null
+    detention_alias_plural_uc: string
+}
+export interface Homework {
+    lesson: string
+    subject: string
+    teacher: string
+    homework_type: string
+    id: number
+    title: string
+    meta_title: string
+    description: string
+    issue_date: string
+    due_date: string
+    completion_time_unit: string
+    completion_time_value: string
+    publish_time: string
+    status: {
+        id: number
+        state: null
+        mark: null
+        mark_relative: number
+        ticked: boolean
+        allow_attachments: string
+        first_seen_date: string
+        last_seen_date: string
+        attachments: Array
+        has_feedback: boolean
+    }
+    validated_links: Array
+    validated_attachments: Array
+}
+export type DisplayDate = 'due_date' | 'issue_date'