Merge pull request #44 from Tch1b0/Tch1b0/issue42

Tch1b0/issue42

Author: Tch1b0

README.md

@@ -4,11 +4,11 @@
 ![badge](https://img.shields.io/github/workflow/status/Tch1b0/dsbmobile.js/ci?label=ci)
 ![badge](https://img.shields.io/github/issues/Tch1b0/dsbmobile.js)
 
-A Javascript wrapper for the [dsbmobile](https://dsbmobile.de) API
+A Javascript package for the [dsbmobile](https://dsbmobile.de) API
 
 ## Installation
 
-```
+```bash
 $ npm install dsbmobile
 ```
 
@@ -17,13 +17,14 @@ $ npm install dsbmobile
 ```js
 import Dsbmobile from "dsbmobile";
 
-let dm = new Dsbmobile("<id>", "<password>");
+const dsb = new Dsbmobile("<id>", "<password>");
 
-let t = await dm.getTimetable();
-console.log(t.entries[0].newSubject);
+dsb.getTimetable().then((timetable) => {
+    console.log(timetable.entries[0].newSubject);
+});
 ```
 
-```bash
+```
 English
 ```
 
@@ -57,3 +58,9 @@ new Dsbmobile({
 After that, all requests will not be sent to the official Server, but to the mydsb.johannespour.de one, which will make a request for you to the resource and add a CORS header.
 
 If you are concerned about privacy and other things, you can [check out the code](https://github.com/Tch1b0/dsb-middleware), because it's open source.
+
+## Incompatible plan
+
+As I only know the layout of my local DSBmobile substitution plan, it is possible that your DSBmobile substitution plan may be incompatible with this package.
+
+If this is the case, please leave a comment below [issue #43](https://github.com/Tch1b0/dsbmobile.js/issues/43), in which you describe the layout of your plan, so a solution can be worked out.

package.json

@@ -1,6 +1,6 @@
 {
     "name": "dsbmobile",
-    "version": "1.1.5",
+    "version": "1.1.6",
     "description": "A Javascript wrapper for the dsbmobile api",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

src/timetable/entry.ts

@@ -1,7 +1,8 @@
 import { isText } from "../utility";
 import { UnknownSubject } from "../";
+import { SubjectContainer } from "./subjectcontainer";
 
-export class Entry {
+export class Entry implements SubjectContainer {
     public readonly date: Date;
     public readonly subjectShorts = new Map<string, string>([
         ["D", "Deutsch"],
@@ -123,7 +124,7 @@ export class Entry {
 
     /**
      * Update the subject shorts with a map
-     * @param subjectShorts
+     * @param subjectShorts the subject shorts mapped to their long name
      *
      * @example
      * ```js

src/timetable/subjectcontainer.ts

@@ -0,0 +1,4 @@
+export interface SubjectContainer {
+    subjectShorts: Map<string, string>;
+    registerSubjectShorts(subjectShorts: Map<string, string>): void;
+}

src/timetable/timetable.ts

@@ -1,11 +1,63 @@
 import { Entry } from "./entry";
-import cheerio from "cheerio";
+import { load } from "cheerio";
+import { SubjectContainer } from "./subjectcontainer";
 
 /**
  * The time table resource
  */
-export class TimeTable {
-    constructor(public readonly entries: Entry[]) {}
+export class TimeTable implements SubjectContainer {
+    public subjectShorts = new Map<string, string>([
+        ["D", "Deutsch"],
+        ["E", "Englisch"],
+        ["WI", "Wirtschaft"],
+        ["GGK", "Geschichte und Gemeinschaftskunde"],
+        ["CH", "Chemie"],
+        ["S", "Sport"],
+        ["M", "Mathe"],
+        ["BK", "Bildende Kunst"],
+        ["BK1", "Bildende Kunst"],
+        ["BK2", "Bildende Kunst"],
+        ["GS", "Global Studies"],
+        ["PH", "Physik"],
+        ["IT", "Informatik"],
+        ["INF", "Informationstechnik"],
+        ["ITÜS", "IT Softwareentwicklung"],
+        ["ITÜH", "IT Hardware"],
+        ["EVR", "Religion"],
+        ["ETH", "Ethik"],
+        ["SP", "Zweitsprache"],
+        ["IFÖM", "Mathe Förderunterricht"],
+        ["IFÖE", "Englisch Förderunterricht"],
+        ["IFÖD", "Deutsch Förderunterricht"],
+    ]);
+
+    constructor(public readonly entries: Entry[]) {
+        entries.forEach((e) => e.registerSubjectShorts(this.subjectShorts));
+    }
+
+    /**
+     * Update the subject shorts for all entries in this timetable instance
+     * @param subjectShorts The subject shorts mapped to their long name
+     *
+     * @example
+     * ```js
+     * timetable.registerSubjectShorts(new Map([["D", "Deutsch"]]))
+     * ```
+     */
+    public registerSubjectShorts(subjectShorts: Map<string, string>): void {
+        for (const [k, v] of subjectShorts) {
+            this.subjectShorts.set(k, v);
+        }
+
+        for (const entry of this.entries) {
+            entry.registerSubjectShorts(subjectShorts);
+        }
+    }
+
+    public addEntry(entry: Entry) {
+        entry.registerSubjectShorts(this.subjectShorts);
+        this.entries.push(entry);
+    }
 
     /**
      * Find a certain entry by the class name
@@ -74,7 +126,7 @@ export class TimeTable {
      * @returns A new `TimeTable` resource
      */
     static fromHtml(rawHtml: string) {
-        const $ = cheerio.load(rawHtml);
+        const $ = load(rawHtml);
 
         const centers = $("center");
         const entries: Entry[] = [];

src/utility.ts

@@ -1,5 +1,3 @@
-/* eslint-disable */
-
 /**
  * Parse a date from string to a Date object.
  * Use this instead of the `Date.parse` function,
@@ -26,6 +24,6 @@ export function parseDate(rawDate: string): Date {
  * @param data the data to validate
  * @returns whether the data is a string
  */
-export function isText(data: any): data is string {
+export function isText(data: string | unknown): data is string {
     return typeof data === "string";
 }

test/main.spec.ts

@@ -42,6 +42,16 @@ describe("Test DSBmobile Wrapper", () => {
         expect(otherEntry.oldSubject).to.eq("CH");
         expect(otherEntry.longOldSubject).to.eq("Chemie");
 
+        otherEntry.registerSubjectShorts(
+            new Map([["CH", "LONG SUBJECT NAME"]]),
+        );
+        expect(otherEntry.oldSubject).to.eq("CH");
+        expect(otherEntry.longOldSubject).to.eq("LONG SUBJECT NAME");
+
+        t.registerSubjectShorts(new Map([["CH", "OTHER SUBJECT NAME"]]));
+        expect(otherEntry.oldSubject).to.eq("CH");
+        expect(otherEntry.longOldSubject).to.eq("OTHER SUBJECT NAME");
+
         const someCertainEntry = t.findByClassName("TGM11/1");
         expect(someCertainEntry).to.be.instanceOf(Array);