@olea-bps/base 1.0.0

package/context/context-news/index.js

@@ -0,0 +1,155 @@
+import { useContext, createContext, useMemo, useState, useCallback, useEffect } from 'react';
+
+import { useTheme } from 'react-native-paper';
+
+import { useLanguage, useStagingServer } from '../../libraries/core';
+
+import CollektorVersion2ApiProvider from './CollektorVersion2ApiProvider';
+
+/**
+ * @typedef News
+ * @property {string} title
+ * @property {string} link
+ * @property {string} author
+ * @property {string} guid
+ * @property {string} pubdate
+ * @property {string} desc
+ * @property {string} descImageUrl
+ * @property {string} contentImageDesc
+ * @property {string} contentImageUrl
+ * @property {string} shortDesc
+ * @property {string} imageUrl
+ */
+
+/**
+ * @typedef Newschannel
+ * @property {Number} feedid
+ * @property {string} title
+ * @property {string} url
+ * @property {string} description
+ * @property {string} language
+ * @property {News[]} news
+ */
+
+export const NewsContext = createContext();
+
+const CollectorVersion2ProviderName = 'hs-collector-v2';
+
+/**
+ * Provider for news context
+ */
+function NewsContextProvider({ children }) {
+    const theme = useTheme();
+    const language = useLanguage();
+    const isStagingServerActive = useStagingServer();
+
+    const componentName = NewsContextProvider.name;
+    const availableLanguages = theme?.appSettings.languages;
+
+    const [newsChannels, setNewsChannels] = useState();
+
+    // Einstellungen für das Stundenplan-Modul
+    const newsSettings = theme?.appSettings?.modules?.news;
+
+    //
+    const newsChannelsSettings = newsSettings?.channels;
+    const filterNewsChannelsByLanguages = !(newsChannelsSettings?.allLanguages ?? false);
+
+    // Einstellungen für API-Provider
+    const newsApiSettings = newsSettings?.api
+    // Soll der Staging-Provider verwendet werden?
+    const newsApiProviderSettings = isStagingServerActive
+        // Wenn ja, werden die Staging Provider-Einstellungen geladen
+        ? newsApiSettings?.staging
+        // Wenn nein, werden die productiven Provider-Einstellungen geladen
+        : newsApiSettings?.production;
+    const newsApiProvider = newsApiProviderSettings?.provider;
+    const newsApiBaseUrl = newsApiProviderSettings?.url;
+
+    // Erstellen des API-Providers bzw. erneuern wenn sich Einstellungen ändern.
+    const apiProvider = useMemo(
+        () => {
+            switch (newsApiProvider?.toLowerCase()) {
+                case CollectorVersion2ProviderName:
+                    console.debug(componentName, ': use collector v2 api');
+                    return new CollektorVersion2ApiProvider.from(newsApiBaseUrl, language);
+                default:
+                    console.log(`${componentName}: Can't build api provider: ${newsApiProvider}`)
+                    return null;
+            }
+        },
+        [newsApiProvider, newsApiBaseUrl, language]
+    );
+
+    const refreshNewsChannels = useCallback(
+        () => {
+            // Nachrichtenkanäle nutzen drei stelligen Sprachcode
+            // Es wird der 2-stellige Sprachcode in den 3-stelligen konvertiert.
+            const newsChannelsFilterLanguageCode = availableLanguages
+                .find(avaiableLanguage => avaiableLanguage.code === language)
+                .extCode;
+
+            let newsChannelsPromise = apiProvider
+                ?.getNewsChannels();
+
+            if (filterNewsChannelsByLanguages) {
+                // Solange die Kollektoren nicht die Sprache über die API-Filtern, müssen wir im Clienten filtern.
+                // Es werden nur Nachrichtenkanäle übernommen, die der aktuellen Sprache entsprechen.
+                newsChannelsPromise = newsChannelsPromise
+                    ?.then(
+                        newsChannels =>
+                            newsChannels.filter(
+                                // Die Spracheinstellung wird mit der Sprache des Newschannels auf Gleichheit verglichen, dabei wird die Groß- bzw. Kleinschreibung ignoriert.
+                                newsChannel => newsChannelsFilterLanguageCode?.localeCompare?.(newsChannel?.language, undefined, { sensitivity: 'accent' }) == 0
+                            )
+                    )
+            }
+
+            return newsChannelsPromise
+                ?.then(setNewsChannels);
+        },
+        [apiProvider, availableLanguages, language, filterNewsChannelsByLanguages]
+    )
+
+    useEffect(
+        () => {
+            refreshNewsChannels();
+        },
+        [refreshNewsChannels]
+    )
+
+    return (
+        <NewsContext.Provider
+            value={{
+                apiProvider: apiProvider,
+                newsChannels,
+                refreshNewsChannels,
+            }}
+        >
+            {children}
+        </NewsContext.Provider>
+    );
+}
+
+function useNewsContext() {
+    return useContext(NewsContext);
+}
+
+function useApiProvider() {
+    const newsContext = useNewsContext();
+
+    return newsContext?.apiProvider;
+}
+
+function useNewsChannels() {
+    const newsContext = useNewsContext();
+
+    return [newsContext?.newsChannels, newsContext?.refreshNewsChannels];
+}
+export {
+    NewsContext as default,
+    NewsContextProvider,
+    useNewsContext,
+    useApiProvider,
+    useNewsChannels,
+}

package/context/context-public-transport-ticket/CollektorVersion2ApiProvider.js

@@ -0,0 +1,45 @@
+import HttpApiProvider, { JsonContentType } from '../../libraries/base-api-provider';
+
+/**
+ * Infos-API-Client für Kollektor
+ */
+export default class CollektorVersion2ApiProvider extends HttpApiProvider {
+
+    /**
+     * Erstellt und gibt die abzufragende URL für ein ÖPNV-Ticket zurück.
+     *
+     * @returns {URL} URL für die Abfrage eines ÖPNV-Tickets.
+     */
+    getTicketUrl() {
+        const getTicketUrl = this.extendBaseUrl(['ticket']);
+
+        return getTicketUrl
+    }
+
+    /**
+     * Gibt ein ÖPNV-Ticket zurück.
+     *
+     * @returns {object} Ein ÖPNV-Ticket.
+     */
+    getTicket() {
+        const getTicketUrl = this.getTicketUrl();
+
+        return this.get(getTicketUrl)
+            .then(response => response.json());
+    }
+
+    /**
+     * Erstellt eine CollektorVersion2ApiProvider-Instanz, welche Englisch und Deutsch initialisiert wird.
+     * Die priorisierte Hauptsprache kann als Paramter übergeben werden.
+     *
+     * @param {string} baseUrl URL des Kollektors
+     * @param {string} [mainLanguage='de'] Hauptsprache, welche priorisiert wird.
+     * @returns {CollektorVersion2ApiProvider} Erstellte CollektorVersion2ApiProvider-Instanz
+     */
+    static from(baseUrl, mainLanguage = 'de', accessToken) {
+        const acceptingLanguages = CollektorVersion2ApiProvider.languagesFromMainLanguages(mainLanguage);
+        const acceptingContentTypes = HttpApiProvider.contentTypesFromContentType(JsonContentType);
+
+        return new CollektorVersion2ApiProvider(baseUrl, acceptingLanguages, acceptingContentTypes, accessToken);
+    }
+}

package/context/context-public-transport-ticket/ProviderErrors.js

@@ -0,0 +1,11 @@
+
+/**
+ * Diese Exception wird ausgelöst, wenn zu dem Nutzer kein ÖPNV-Ticket abgeholt werden kann.
+ */
+export class TicketNotFoundError extends Error {
+
+    constructor() {
+        super('User has no ticket');
+        this.name = this.constructor.name;
+    }
+}

package/context/context-public-transport-ticket/index.js

@@ -0,0 +1,175 @@
+/**
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { createContext, useEffect, useContext, useMemo, useCallback } from 'react'
+
+import { useTheme } from 'react-native-paper';
+
+import { useSecureStoredState } from '../../libraries/stored-state';
+import { useLanguage, useStagingServer } from '../../libraries/core';
+import { useAccessToken } from '../context-user';
+
+import CollektorVersion2ApiProvider from './CollektorVersion2ApiProvider';
+
+/**
+ * @typedef Ticket
+ * @property {string} barcode
+ * @property {string} owner
+ * @property {date} valid_from
+ * @property {date} valid_to
+ */
+
+/**
+ * @typedef PublicTransportTicketContext
+ * @property {string} ticketBarcode
+ * @property {string} ticketOwner
+ * @property {string} ticketValidFrom
+ * @property {string} ticketValidTo
+ * @property {() => Promise<void>} refreshTicket
+ */
+
+const ticketBarcodeStoreKey = 'publictransportticket.ticketBarcode';
+const ticketOwnerStoreKey = 'publictransportticket.ticketOwner';
+const ticketValidFromStoreKey = 'publictransportticket.ticketValidFrom';
+const ticketValidToStoreKey = 'publictransportticket.ticketValidTo';
+
+const PublicTransportTicketContext = createContext();
+
+/**
+ * Provider for public transport ticket context
+ */
+function PublicTransportTicketContextProvider({ children }) {
+    const componentName = PublicTransportTicketContextProvider.name;
+    const theme = useTheme();
+    const isStagingServerActive = useStagingServer();
+    const language = useLanguage();
+    const accessToken = useAccessToken();
+
+    // Einstellungen für das ÖPNV-Ticket-Moduls
+    const publicTransportTicketSettings = theme?.appSettings?.modules?.publicTransportTicket;
+    // Einstellungen für die API-Provider
+    const publicTransportTicketApiSettings = publicTransportTicketSettings?.api;
+    // Soll der Staging-Provider verwendet werden?
+    const publicTransportTicketApiProviderSettings = isStagingServerActive
+        // Wenn ja, werden die Staging Provider-Einstellungen geladen
+        ? publicTransportTicketApiSettings?.staging
+        // Wenn nein, werden die productiven Provider-Einstellungen geladen
+        : publicTransportTicketApiSettings?.production;
+    // Basis URL der API
+    const publicTransportTicketApiBaseUrl = publicTransportTicketApiProviderSettings?.url;
+
+    const apiProvider = useMemo(
+        () =>
+            CollektorVersion2ApiProvider.from(
+                publicTransportTicketApiBaseUrl,
+                language,
+                accessToken,
+            ),
+        [publicTransportTicketApiBaseUrl, language, accessToken]
+    )
+
+    const [ticketBarcode, setTicketBarcode] = useSecureStoredState(ticketBarcodeStoreKey, null);
+    const [ticketOwner, setTicketOwner] = useSecureStoredState(ticketOwnerStoreKey, null);
+    const [ticketValidFrom, setTicketValidFrom] = useSecureStoredState(ticketValidFromStoreKey, null);
+    const [ticketValidTo, setTicketValidTo] = useSecureStoredState(ticketValidToStoreKey, null);
+
+    const refreshTicket = useCallback(
+        apiProvider && accessToken
+            ? () => apiProvider.getTicket()
+                .then(
+                    ticket => {
+                        setTicketBarcode(ticket?.barcode ?? null);
+                        setTicketOwner(ticket?.owner ?? null);
+                        setTicketValidFrom(ticket?.validFrom ?? null);
+                        setTicketValidTo(ticket?.validTo ?? null);
+                        console.debug(componentName, ':', 'Get ticket barcode', ':', ticket.barcode);
+                    }
+                )
+            : undefined
+        ,
+        [apiProvider, accessToken, componentName]
+    )
+
+    useEffect(
+        () => {
+            refreshTicket?.();
+        },
+        [refreshTicket]
+    );
+
+    return (
+        <PublicTransportTicketContext.Provider
+            value={{
+                ticketBarcode,
+                ticketOwner,
+                ticketValidFrom,
+                ticketValidTo,
+                refreshTicket,
+            }}
+        >
+            {children}
+        </PublicTransportTicketContext.Provider>
+    );
+}
+
+/**
+ * Liefert den PublicTransportTicketContext zurück.
+ * @return {PublicTransportTicketContext} Kontext des Ticket-Modules
+ * @example
+ * const infoContext = usePublicTransportTicketContext();
+ */
+function usePublicTransportTicketContext() {
+    return useContext(PublicTransportTicketContext);
+}
+
+/**
+ * Liefert alle noch austehenden Infos zurück.
+ * Austehende Infos sind noch nicht als angezeigt markiert.
+ *
+ * @returns {[barcode: string|undefined, owner: string|undefined, validForm: string|undefined, validTo: string|undefined, refreshTicket: () => Promise<void>|undefined]}
+ * @example
+ * const [
+ *     ticketBarcode,
+ *     ticketOwner,
+ *     ticketValidFrom,
+ *     ticketValidTo,
+ *     refreshTicket,
+ *     refreshTicket
+ * ] = usePublicTransportTicket();
+ *
+ * useEffect(
+ *     () => {
+ *         refreshInfos?.()
+ *     },
+ *     [refreshInfos]
+ * );
+ */
+function usePublicTransportTicket() {
+    const publicTransportTicketContext = usePublicTransportTicketContext();
+
+    return [
+        publicTransportTicketContext?.ticketBarcode,
+        publicTransportTicketContext?.ticketOwner,
+        publicTransportTicketContext?.ticketValidFrom,
+        publicTransportTicketContext?.ticketValidTo,
+        publicTransportTicketContext?.refreshTicket
+    ];
+}
+
+export {
+    usePublicTransportTicketContext as default,
+    PublicTransportTicketContextProvider,
+    usePublicTransportTicketContext,
+    usePublicTransportTicket,
+}

package/context/context-timetable/CollectorVersion2ApiProvider.js

@@ -0,0 +1,102 @@
+import HttpApiProvider from '../../libraries/base-api-provider';
+import { TimetableNotFoundError } from './ProviderErrors';
+
+/**
+ * API-Client for Kollektor
+ */
+export default class CollectorVersion2ApiProvider extends HttpApiProvider {
+
+    /**
+     * Name des Providers
+     * @type {string}
+     */
+    static name = 'hs-collector-v2';
+
+    /**
+     * @param {string} baseUrl - URL which is used as the basis for the query URLs.
+     * @param {string[]} acceptingLanguages - List of languages that are queried by the ASiST server. The priority is based on the order of the languages in the array.
+     */
+    constructor(baseUrl, acceptingLanguages) {
+        // ContentTypes wird auf JSON festgesetzt, da der ASiST-Server nur JSON spricht.
+        super(baseUrl, acceptingLanguages, ['application/json']);
+    }
+
+    /**
+     * Returns the request URL to get all courses of a personal timetable code from the collektor.
+     *
+     * If the start date and end date are passed, query filter parameters are added to the URL.
+     * These parameters restrict the events that are sent.
+     * Only events that take place between the start date and end date are sent back.
+     *
+     * @param {string} personalTimetableCode Personal timetable code to get.
+     * @param {string} [startDate] Start date in ISO 8601 format.
+     * @param {string} [endDate] End date in ISO 8601 format.
+     * @returns {URL} URL to get courses of timetable code with optional query parameter.
+     */
+    getByCodeUrl(personalTimetableCode, startDate, endDate) {
+        const getByCodeUrl = this.extendBaseUrl(['courses', 'shortcode', personalTimetableCode]);
+
+        if (startDate) {
+            getByCodeUrl.searchParams.set('start', startDate)
+        }
+
+        if (endDate) {
+            getByCodeUrl.searchParams.set('end', endDate)
+        }
+
+        return getByCodeUrl
+    }
+
+    /**
+     * Returns a list of all courses from the queried personal timetable code.
+     *
+     * The list can be restricted by the startDate and endDate, which means that only lectures that take place between the start date and end date are requested.
+     *
+     * If the collector could not find a timetable for the timetable code, a {@link TimetableNotFoundError} exception is triggered.
+     *
+     * @param {String} personalTimetableCode Personal code of the timetable.
+     * @param {string} [startDate] Start date in ISO 8601 format.
+     * @param {string} [endDate] End date in ISO 8601 format.
+     * @returns {Array} Array of all courses of the timetable.
+     */
+    getByCode(personalTimetableCode, startDate, endDate) {
+        const getByCodeUrl = this.getByCodeUrl(personalTimetableCode, startDate, endDate);
+
+        return this.get(getByCodeUrl)
+            .then(
+                response => {
+                    if (response.status === 404) {
+                        throw new TimetableNotFoundError(personalTimetableCode);
+                    } else {
+                        return response.json();
+                    }
+                }
+            );
+    }
+
+    /**
+     * Creates a CollektorVersion2ApiProvider instance initialised to a list of standard languages, where the mainLanguage parameter specifies the mainLanguage.
+     * @param {string} baseUrl - URL which is used as the basis for the query URLs.
+     * @param {string} mainLanguage - Main language which is prioritised.
+     * @returns {CollectorVersion2ApiProvider} Created CollectorVersion2ApiProvider instance.
+     */
+    static from(baseUrl, mainLanguage = 'de') {
+        const acceptingLanguages = CollectorVersion2ApiProvider.languagesFromMainLanguages(mainLanguage);
+
+        return new CollectorVersion2ApiProvider(baseUrl, acceptingLanguages);
+    }
+
+    /**
+     * Erstellt eine CollektorVersion2ApiProvider-Instanz, welche Englisch und Deutsch initialisiert wird.
+     * Die priorisierte Hauptsprache kann als Paramter übergeben werden.
+     *
+     * @param {object} settingsObject Objekt mit Providereinstellungen
+     * @param {string} [mainLanguage='de'] Hauptsprache, welche priorisiert wird.
+     * @returns {CollectorVersion2ApiProvider} Erstellte CollektorVersion2ApiProvider-Instanz
+     */
+    static fromSettingsObject(settingsObject, mainLanguage = 'de') {
+        const { url } = settingsObject;
+
+        return CollectorVersion2ApiProvider.from(url, mainLanguage);
+    }
+}

package/context/context-timetable/ProviderErrors.js

@@ -0,0 +1,22 @@
+
+/**
+ * Diese Exception wird ausgelöst, wenn zu dem Studenplancode kein Stundenplan abgeholt werden kann.
+ */
+export class TimetableNotFoundError extends Error {
+
+    /**
+     * Stundenplancode welcher keinem Stundenplan angehörig ist.
+     * @type {string}
+     */
+    timetableCode
+
+    /**
+     *
+     * @param {string} timetableCode Stundenplancode, welcher zu einem Fehler führte, weil dieser mit keinem Stundenplan verknüpft ist
+     */
+    constructor(timetableCode) {
+        super(`Timetable code ${timetableCode} is not linked to a timetable`);
+        this.timetableCode = timetableCode;
+        this.name = this.constructor.name;
+    }
+}