@hmt/svws-core 0.0.0-stage → 1.5.0

package/README.md

@@ -1,3 +1,29 @@
-# Temporary Holding Version
+# SVWS-NRW CoreTS-Bibliothek
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Die CoreTS-Bibliothek ist eine aus Java transpilierte Bibliothek, die alle für den SVWS-Server notwendigen Typen zur Verfügung stellt.
+Ebenso wird ein API-Client mitgeliefert, der mit einem SVWS-Server kommunizieren kann.
+
+Alle API-Anfragen bzw- Antworten sind typsicher mit dieser Bibliothek.
+
+Beispiel zur Nutzung der CoreTS-Bibliothek:
+
+```ts
+import { ApiServer, List, DBSchemaListeEintrag, ArrayList, SchuelerListeEintrag } from "@core"
+
+const url = process.env.SVWS_URL;
+const user = process.env.SVWS_USER;
+const password = process.env.PASSWORD;
+const server = new ApiServer(url, "", "");
+let schemata: Ref<List<DBSchemaListeEintrag>> = new ArrayList();
+let api: ApiServer | undefined;
+let schueler: List<SchuelerListeEintrag> = new ArrayList();
+const schemata = await server.getConfigDBSchemata();
+try {
+	const schema = schemata.value.get(0).name;
+	api = new ApiServer(url, user, password);
+	schueler = await api.getSchuelerAktuell(schema);
+	console.log(schueler)
+} catch(error) {
+	console.log("Es trat ein Verbindungsfehler auf: ", error)
+}
+```

package/dist/api/ApiExternal.js

@@ -0,0 +1,127 @@
+import { BaseApi } from '../api/BaseApi';
+import { ArrayList } from '../java/util/ArrayList';
+import { LernplattformV1 } from '../core/data/lernplattform/v1/LernplattformV1';
+import { LernplattformV1Export } from '../core/data/lernplattform/v1/LernplattformV1Export';
+import { SchuljahresabschnittV1 } from '../core/data/schuljahresabschnitt/v1/SchuljahresabschnittV1';
+export class ApiExternal extends BaseApi {
+    /**
+     *
+     * Erstellt eine neue API mit der übergebenen Konfiguration.
+     *
+     * @param {string} url - die URL des Servers: Alle Pfadangaben sind relativ zu dieser URL
+     * @param {string} username - der Benutzername für den API-Zugriff
+     * @param {string} password - das Kennwort des Benutzers für den API-Zugriff
+     */
+    constructor(url, username, password) {
+        super(url, username, password);
+    }
+    /**
+     * Implementierung der GET-Methode getLernplattformen für den Zugriff auf die URL https://{hostname}/api/external/{schema}/v1/lernplattformen/
+     *
+     * Erstellt eine Liste aller vorhandenen Lernplattformen, insofer die notwendige Berechtigung vorliegen.
+     *
+     * Mögliche HTTP-Antworten:
+     *   Code 200: Eine Liste von Lernplattformen
+     *     - Mime-Type: application/json
+     *     - Rückgabe-Typ: List<LernplattformV1>
+     *   Code 403: Der SVWS-Benutzer hat keine Rechte, um Lernplattformen anzusehen.
+     *   Code 404: Keine Lernplattformen gefunden
+     *
+     * @param {string} schema - der Pfad-Parameter schema
+     *
+     * @returns Eine Liste von Lernplattformen
+     */
+    async getLernplattformen(schema) {
+        const path = "/api/external/{schema}/v1/lernplattformen/"
+            .replace(/{schema\s*(:[^{}]+({[^{}]+})*)?}/g, schema);
+        const result = await super.getJSON(path);
+        const obj = JSON.parse(result);
+        const ret = new ArrayList();
+        obj.forEach((elem) => {
+            const text = JSON.stringify(elem);
+            ret.add(LernplattformV1.transpilerFromJSON(text));
+        });
+        return ret;
+    }
+    /**
+     * Implementierung der GET-Methode getLernplattformenExport für den Zugriff auf die URL https://{hostname}/api/external/{schema}/v1/lernplattformen/{idLernplattform : \d+}/{idSchuljahresabschnitt : \d+}
+     *
+     * Es werden alle relevanten Daten zu Jahrgängen, Klassen, Lehrern, Schülern, Fächern und Lerngruppen aus der SVWS-DB geladen und für den Export bezogen auf eine Lernplattform aufbereitet und zurückgegeben.
+     *
+     * Mögliche HTTP-Antworten:
+     *   Code 200: Die Daten für den Lernplattformen Datenexport
+     *     - Mime-Type: application/json
+     *     - Rückgabe-Typ: LernplattformV1Export
+     *   Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Lernplattformen Datenexport anzufordern.
+     *   Code 404: Es wurden nicht alle benötigten Ressourcen gefunden.
+     *
+     * @param {string} schema - der Pfad-Parameter schema
+     * @param {number} idLernplattform - der Pfad-Parameter idLernplattform
+     * @param {number} idSchuljahresabschnitt - der Pfad-Parameter idSchuljahresabschnitt
+     *
+     * @returns Die Daten für den Lernplattformen Datenexport
+     */
+    async getLernplattformenExport(schema, idLernplattform, idSchuljahresabschnitt) {
+        const path = "/api/external/{schema}/v1/lernplattformen/{idLernplattform : \\d+}/{idSchuljahresabschnitt : \\d+}"
+            .replace(/{schema\s*(:[^{}]+({[^{}]+})*)?}/g, schema)
+            .replace(/{idLernplattform\s*(:[^{}]+({[^{}]+})*)?}/g, idLernplattform.toString())
+            .replace(/{idSchuljahresabschnitt\s*(:[^{}]+({[^{}]+})*)?}/g, idSchuljahresabschnitt.toString());
+        const result = await super.getJSON(path);
+        const text = result;
+        return LernplattformV1Export.transpilerFromJSON(text);
+    }
+    /**
+     * Implementierung der GET-Methode getLernplattformenExportAsGzip für den Zugriff auf die URL https://{hostname}/api/external/{schema}/v1/lernplattformen/{idLernplattform : \d+}/{idSchuljahresabschnitt : \d+}/gzip
+     *
+     * Es werden alle relevanten Daten zu Jahrgängen, Klassen, Lehrern, Schülern, Fächern und Lerngruppen aus der SVWS-DB geladen und für den Export bezogen auf eine Lernplattform aufbereitet und komprimiert im gzip-Format zurückgegeben.
+     *
+     * Mögliche HTTP-Antworten:
+     *   Code 200: Die Daten für den Lernplattformen Datenexport
+     *     - Mime-Type: application/octet-stream
+     *     - Rückgabe-Typ: ApiFile
+     *   Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Lernplattformen Datenexport anzufordern.
+     *   Code 404: Es wurden nicht alle benötigten Ressourcen gefunden.
+     *
+     * @param {string} schema - der Pfad-Parameter schema
+     * @param {number} idLernplattform - der Pfad-Parameter idLernplattform
+     * @param {number} idSchuljahresabschnitt - der Pfad-Parameter idSchuljahresabschnitt
+     *
+     * @returns Die Daten für den Lernplattformen Datenexport
+     */
+    async getLernplattformenExportAsGzip(schema, idLernplattform, idSchuljahresabschnitt) {
+        const path = "/api/external/{schema}/v1/lernplattformen/{idLernplattform : \\d+}/{idSchuljahresabschnitt : \\d+}/gzip"
+            .replace(/{schema\s*(:[^{}]+({[^{}]+})*)?}/g, schema)
+            .replace(/{idLernplattform\s*(:[^{}]+({[^{}]+})*)?}/g, idLernplattform.toString())
+            .replace(/{idSchuljahresabschnitt\s*(:[^{}]+({[^{}]+})*)?}/g, idSchuljahresabschnitt.toString());
+        const data = await super.getOctetStream(path);
+        return data;
+    }
+    /**
+     * Implementierung der GET-Methode getSchuljahresabschnitte für den Zugriff auf die URL https://{hostname}/api/external/{schema}/v1/schuljahresabschnitte/
+     *
+     * Erstellt eine Liste aller vorhandenen Schuljahresabschnitte, insofern die notwendige Berechtigung vorliegt.
+     *
+     * Mögliche HTTP-Antworten:
+     *   Code 200: Eine Liste von Schuljahresabschnitten
+     *     - Mime-Type: application/json
+     *     - Rückgabe-Typ: List<SchuljahresabschnittV1>
+     *   Code 403: Der SVWS-Benutzer hat keine Rechte, um Schuljahresabschnitte anzusehen.
+     *   Code 500: Unspezifizierter Fehler (z. B. beim Datenbankzugriff)
+     *
+     * @param {string} schema - der Pfad-Parameter schema
+     *
+     * @returns Eine Liste von Schuljahresabschnitten
+     */
+    async getSchuljahresabschnitte(schema) {
+        const path = "/api/external/{schema}/v1/schuljahresabschnitte/"
+            .replace(/{schema\s*(:[^{}]+({[^{}]+})*)?}/g, schema);
+        const result = await super.getJSON(path);
+        const obj = JSON.parse(result);
+        const ret = new ArrayList();
+        obj.forEach((elem) => {
+            const text = JSON.stringify(elem);
+            ret.add(SchuljahresabschnittV1.transpilerFromJSON(text));
+        });
+        return ret;
+    }
+}