Merge pull request #45 from Tch1b0/add-incompatible-plan-exception

Exceptions: add new IncompatiblePlan exception

Author: Tch1b0

.github/workflows/ci.yml

@@ -7,13 +7,13 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x, 15.x, 16.x, 17.x]
+        node-version: [10.x, 12.x, 14.x, 15.x, 16.x, 17.x, 18.x]
 
     steps:
       - uses: actions/checkout@v2
 
       - name: Setup Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2.4.1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -30,9 +30,9 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Setup Node.js 17.x
-        uses: actions/setup-node@v2.4.1
+        uses: actions/setup-node@v3
         with:
-          node-version: 17.x
+          node-version: 18.x
 
       - name: Install dependencies
         run: npm ci

.github/workflows/deploy.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2.4.1
+      - uses: actions/setup-node@v3
         with:
           # Declare the registry where the package will be published
           registry-url: https://registry.npmjs.org/

.github/workflows/docs.yml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Setup node.js
-        uses: actions/setup-node@v2.4.1
+        uses: actions/setup-node@v3
 
       - name: Install dependencies
         run: npm ci
@@ -24,7 +24,7 @@ jobs:
 
       - name: Deploy to GitHub Pages
         if: success()
-        uses: crazy-max/ghaction-github-pages@v2
+        uses: crazy-max/ghaction-github-pages@v3
         with:
           target_branch: gh-pages
           build_dir: docs

README.md

@@ -1,6 +1,7 @@
 # dsbmobile.js
 
 ![badge](https://img.shields.io/github/license/Tch1b0/dsbmobile.js)
+[![badge](https://img.shields.io/badge/docs-%F0%9F%93%96-blue)](https://tch1b0.github.io/dsbmobile.js/)
 ![badge](https://img.shields.io/github/workflow/status/Tch1b0/dsbmobile.js/ci?label=ci)
 ![badge](https://img.shields.io/github/issues/Tch1b0/dsbmobile.js)
 

package.json

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

src/dsbmobile.ts

@@ -1,12 +1,13 @@
 import {
+    NewsPost,
     DocumentPost,
     DocumentPostCollection,
     NewsPostCollection,
     TimeTable,
     MissingToken,
+    IncompatiblePlan,
 } from "./";
 import axios from "axios";
-import { NewsPost } from "./";
 import { Requester } from "./requester";
 
 /**
@@ -115,6 +116,7 @@ export default class Dsbmobile {
     /**
      * Get your current **Timetable**
      * @throws `MissingToken` if the token isn't declared
+     * @throws `IncompatiblePlan` if the format of the targeted plan is not supported
      * @returns A new `TimeTable` resource
      */
     public async getTimetable(): Promise<TimeTable> {
@@ -131,7 +133,11 @@ export default class Dsbmobile {
 
         resp = await this.requester.get(resURL);
 
-        return TimeTable.fromHtml(resp.data);
+        try {
+            return TimeTable.fromHtml(resp.data);
+        } catch (error) {
+            throw new IncompatiblePlan();
+        }
     }
 
     /**

src/errors.ts

@@ -42,3 +42,11 @@ export class UnknownFetchError extends Error {
         );
     }
 }
+
+export class IncompatiblePlan extends Error {
+    constructor() {
+        super(
+            "it seems like the format of the targeted substitution-plan is not supported. Please read https://github.com/Tch1b0/dsbmobile.js#incompatible-plan",
+        );
+    }
+}

src/index.ts

@@ -2,7 +2,12 @@ import Dsbmobile from "./dsbmobile";
 
 export default Dsbmobile;
 export { DsbmobileConfig } from "./dsbmobile";
-export { UnknownSubject, WrongCredentials, MissingToken } from "./errors";
+export {
+    UnknownSubject,
+    WrongCredentials,
+    MissingToken,
+    IncompatiblePlan,
+} from "./errors";
 export { NewsPostCollection, NewsPost } from "./news";
 export { TimeTable, Entry } from "./timetable";
 export { DocumentPostCollection, DocumentPost } from "./documents";

tsconfig.json

@@ -1,6 +1,6 @@
 {
     "compilerOptions": {
-        "module": "commonjs",
+        "module": "CommonJS",
         "baseUrl": "src",
         "target": "es5",
         "noImplicitAny": false,
@@ -13,5 +13,6 @@
         "downlevelIteration": true,
         "resolveJsonModule": true
     },
-    "include": ["src/**/*"]
+    "include": ["src/**/*"],
+    "exclude": ["node_modules/**/*"]
 }

typedoc.json

@@ -1,4 +1,5 @@
 {
+    "$schema": "https://typedoc.org/schema.json",
     "entryPoints": ["./src/index.ts"],
     "darkHighlightTheme": "dracula",
     "out": "docs"