docs!

.gitignore

@@ -119,5 +119,3 @@ dist
 
 tests/config.json
 tests/sandbox.js
-
-docs/

.prettierignore

@@ -1,5 +1,4 @@
 dist
-docs
 node_modules
 pnpm-lock.yaml
 .prettierrc.json

docs/README.md

@@ -0,0 +1,285 @@
+<p align="center">
+	<h1 align="center">ClassCharts API JS</h1>
+	<p align="center">
+	A typescript wrapper for getting information from the Classcharts API
+	</p>
+</p>
+<p align="center">
+	<a href="https://github.com/classchartsapi/classcharts-api-js">Source</a>
+	<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+	<a href="https://github.com/classchartsapi/classcharts-api-js/issues">Issues</a>
+	<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+	<a href="https://www.npmjs.com/package/classcharts-api">NPM</a>
+	<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+	<a href="https://discord.gg/DTcwugcgZ2">Discord</a>
+	<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+	<a href="https://classchartsapi.github.io/classcharts-api-js/typedoc/">TypeDoc</a>
+	<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+	<a href="https://classchartsapi.github.io/api-docs/">API Docs</a>
+</p>
+
+# Introduction
+
+The ClassCharts API is a typescript wrapper around the ClassCharts API. It allows you to easily make requests to the ClassCharts API without having to worry about the underlying implementation of making requests.
+
+## Help
+
+For any help with the library, please join the [discord](https://discord.gg/DTcwugcgZ2) where you can ask questions and get help from the community.
+
+# Installation
+
+## Requirements
+
+- Node.js 16 or newer
+
+## NPM
+
+```bash
+npm install classcharts-api # npm
+yarn add classcharts-api # yarn
+pnpm add classcharts-api # pnpm
+```
+
+# Logging In
+
+Before making any requests, you must login to the client. This will get you a session ID which will be used for all requests.
+
+## Student Client
+
+```typescript
+import { StudentClient } from "classcharts-api";
+
+// Date of birth MUST in the format DD/MM/YYYY
+const client = new StudentClient("classchartsCode", "01/1/2000");
+await client.login();
+```
+
+## Parent Client
+
+```typescript
+import { ParentClient } from "classcharts-api";
+
+const client = new ParentClient("username", "password");
+await client.login();
+```
+
+# Universal Methods
+
+All the following methods can be used on both the student and parent client. Each example expects the client to be already logged in.
+
+## `.getStudentInfo`
+
+```typescript
+const studentInfo = await client.getStudentInfo();
+console.log(studentInfo);
+/**
+{
+  success: 1,
+  data: {
+    user: {
+      id: 2339528,
+      ...
+    }
+  },
+  meta: {
+    session_id: '5vf2v7n5uk9jftrxaarrik39vk6yjm48',
+    ...
+  }
+}
+*/
+```
+
+## `.getActivity`
+
+```typescript
+// Dates must be in format YYYY-MM-DD
+const activity = await client.getActivity({
+  from: "2023-04-01",
+  to: "2023-05-10",
+  last_id: "12",
+});
+console.log(activity);
+```
+
+## `.getFullActivity`
+
+```typescript
+// Dates must be in format YYYY-MM-DD
+const activity = await client.getFullActivity({
+  from: "2023-04-01",
+  to: "2023-05-10",
+});
+console.log(activity);
+```
+
+## `.getBehaviour`
+
+Gets behaviour for a given date range.
+
+```typescript
+// Dates must be in format YYYY-MM-DD
+const behaviour = await client.getBehaviour({
+  from: "2023-04-01",
+  to: "2023-05-10",
+});
+console.log(behaviour);
+
+/**
+{
+  "success": 1,
+  "data": {
+    "timeline": [
+      {
+        "positive": 426,
+        ...
+      },
+    ],
+	...
+  "meta": {
+    "start_date": "2023-04-01T00:00:00+00:00",
+    ...
+  }
+}
+*/
+```
+
+## `.getHomeworks`
+
+Gets homeworks for a given date range.
+
+```typescript
+// Dates must be in format YYYY-MM-DD
+const homeworks = await client.getHomeworks({
+  from: "2023-04-01",
+  to: "2023-05-10",
+	displayDate: 'issue_date' // Can be 'due_date' or 'issue_date'
+});
+console.log(homeworks);
+
+/**
+{
+  success: 1,
+  data: [
+    {
+      lesson: '7A/Pe1',
+			...
+		},
+  ],
+  meta: {
+    start_date: '2023-04-01T00:00:00+00:00',
+		...
+  }
+}
+
+```
+
+## `.getLessons`
+
+Gets lessons for a specific date.
+
+```typescript
+// Dates must be in format YYYY-MM-DD
+const lessons = await client.getLessons({
+  date: "2023-04-01",
+});
+console.log(lessons);
+
+/**
+{
+  "success": 1,
+  "data": [
+    {
+      "teacher_name": "Mr J Doe",
+      ...
+		}
+		...
+  ],
+  "meta": {
+    "dates": [
+      "2023-05-04"
+    ],
+    ...
+  }
+}
+*/
+```
+
+## `.getBadges`
+
+Gets all earned badges.
+
+```typescript
+const badges = await client.getBadges();
+console.log(badges);
+
+/**
+{
+  success: 1,
+  data: [
+    {
+      id: 123,
+			name: 'Big Badge',
+			...
+    },
+		...
+  ],
+  meta: []
+}
+*/
+```
+
+## `.getAnnouncements`
+
+Gets all announcements.
+
+```typescript
+const announcements = await client.getAnnouncements();
+console.log(announcements);
+```
+
+## `.getDetentions`
+
+Gets all detentions.
+
+```typescript
+const detentions = await client.getDetentions();
+console.log(detentions);
+```
+
+## `.getAttendance`
+
+Gets attendance.
+
+```typescript
+const attendance = await client.getAttendance();
+console.log(attendance);
+```
+
+# Parent Specific Methods
+
+## `.getPupils`
+
+Gets a list of all pupils the parent has access to.
+
+```typescript
+const pupils = await client.getPupils();
+console.log(pupils);
+/**
+[
+	{
+		id: 123,
+		name: 'John Doe',
+		...
+	},
+	...
+]
+*/
+```
+
+## `.selectPupil`
+
+Selects a pupil to make subsequent requests for.
+
+```typescript
+await client.selectPupil(123);
+```

docs/index.html

@@ -0,0 +1,38 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>Classcharts-API</title>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+    <!-- <meta name="description" content="Description"> -->
+    <meta
+      name="viewport"
+      content="width=device-width, initial-scale=1.0, minimum-scale=1.0"
+    />
+    <link
+      rel="stylesheet"
+      href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css"
+    />
+    <script
+      async
+      src="https://umami.jaminit.co.uk/script.js"
+      data-website-id="3f01674a-5c63-47a2-962b-43d0c62c7c6c"
+      data-domains="classchartsapi.github.io"
+    ></script>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script>
+      window.$docsify = {
+        name: "ClassCharts API JS",
+        repo: "classchartsapi/classcharts-api-js",
+        auto2top: true,
+        autoHeader: true,
+      };
+    </script>
+    <!-- Docsify v4 -->
+    <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+    <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
+    <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-typescript.min.js"></script>
+  </body>
+</html>

typedoc.config.cjs

@@ -13,7 +13,7 @@ module.exports = {
     Github: "https://github.com/classchartsapi/classcharts-api-js",
   },
   includeVersion: true,
-  out: "docs",
+  out: "docs/typedoc",
   sort: "required-first",
   umamiOptions: {
     src: "https://umami.jaminit.co.uk/script.js",