@olea-bps/base 1.0.0

package/context/context-info-dialog/index.js

@@ -0,0 +1,190 @@
+/**
+ * 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 { useSecureStoredReducer, useSecureStoredState } from '../../libraries/stored-state';
+import { useLanguage, useStagingServer } from '../../libraries/core';
+
+import CollektorVersion2ApiProvider from './CollektorVersion2ApiProvider';
+
+/**
+ * @typedef Info
+ * @property {string} id
+ * @property {string} title
+ * @property {string} message
+ * @property {date} expiry
+ */
+
+/**
+ * @typedef InfoContext
+ * @property {Info[]} pendingInfos
+ * @property {(infoId: string) => Promise<void> } setInfoDisplayed
+ */
+
+const InfoDialogInfosStoreKey = 'infodisplay.infos';
+const InfoDialogDisplayedInfosStoreKey = 'infodisplay.displayedInfos';
+
+function displayedInfosReducer(state, addingInfo) {
+    return [
+        ...(state ?? []),
+        addingInfo,
+    ]
+}
+
+const InfoContext = createContext();
+
+/**
+ * Provider for info dialog context
+ */
+export default function InfoContextProvider({ children }) {
+    const componentName = InfoContextProvider.name;
+    const theme = useTheme();
+    const isStagingServerActive = useStagingServer();
+    const language = useLanguage();
+
+    // Einstellungen für das InfoDialog-Moduls
+    const infoDialogSettings = theme?.appSettings?.modules?.infodialog;
+    // Einstellungen für die API-Provider
+    const infoDialogApiSettings = infoDialogSettings?.api;
+    // Soll der Staging-Provider verwendet werden?
+    const infoDialogApiProviderSettings = isStagingServerActive
+        // Wenn ja, werden die Staging Provider-Einstellungen geladen
+        ? infoDialogApiSettings?.staging
+        // Wenn nein, werden die productiven Provider-Einstellungen geladen
+        : infoDialogApiSettings?.production;
+    // Basis URL der API
+    const infoDialogApiBaseUrl = infoDialogApiProviderSettings?.url;
+
+    const apiProvider = useMemo(
+        () =>
+            CollektorVersion2ApiProvider.from(
+                infoDialogApiBaseUrl,
+                language
+            ),
+        [infoDialogApiBaseUrl, language]
+    )
+
+    const [infos, setInfos] = useSecureStoredState(InfoDialogInfosStoreKey, []);
+    const [displayedInfos, addDisplayedInfos] = useSecureStoredReducer(InfoDialogDisplayedInfosStoreKey, displayedInfosReducer, []);
+
+    const pendingInfos = useMemo(
+        () => {
+            return infos?.filter?.(info => !displayedInfos.includes(info?.id));
+        },
+        [infos, displayedInfos]
+    )
+
+    console.debug(componentName, ':', 'infos', ':', infos);
+    console.debug(componentName, ':', 'pending infos', ':', pendingInfos);
+
+    //// Estellen des API-Providers bzw. erneuern wenn sich Einstellungen sich ändern.
+    //const apiProvider = useMemo(
+    //    () => {
+    //        switch (timetableApiProvider?.toLowerCase()) {
+    //            case AsistServerProviderName:
+    //                console.debug(componentName, ': use asist server api');
+    //                return new AsistServerApiProvider.from(timetableApiBaseUrl, timetableApiUniversity, 'de');
+    //                break;
+    //            case CollectorVersion2ProviderName:
+    //                console.debug(componentName, ': use collector v2 api');
+    //                return new CollektorVersion2ApiProvider.from(timetableApiBaseUrl);
+    //                break;
+    //            default:
+    //                console.log(`${componentName}: Can't build api provider: ${timetableApiProvider}`)
+    //                return null;
+    //        }
+    //    },
+    //    [timetableApiProvider, timetableApiBaseUrl, timetableApiUniversity]
+    //);
+
+    /**
+     * Makiert eine Info als angezeigt.
+     * @param {string} infoID ID der Info, welche als angezeigt makiert werden soll
+     */
+    const setInfoDisplayed = useCallback(
+        async (infoID) => {
+            addDisplayedInfos(infoID);
+        },
+        [addDisplayedInfos]
+    );
+
+    const refreshInfos = useCallback(
+        () => {
+            apiProvider.getInfos()
+                .then(
+                    infos => {
+                        setInfos(infos);
+                        console.debug(componentName, ':', 'Get infos', ':', infos);
+                    }
+                );
+        },
+        [apiProvider, setInfos, componentName]
+    )
+
+    // Aktualiseren Infos beim Starten der App
+    useEffect(
+        () => {
+            refreshInfos();
+        },
+        [refreshInfos]
+    );
+
+    return (
+        <InfoContext.Provider
+            value={{
+                pendingInfos,
+                setInfoDisplayed,
+                refreshInfos,
+            }}
+        >
+            {children}
+        </InfoContext.Provider>
+    );
+}
+
+/**
+ * Liefert den InfoContext zurück.
+ * @return {InfoContext} Kontext des Info-Modules
+ * @example
+ * const infoContext = useInfoContext();
+ */
+export function useInfoContext() {
+    return useContext(InfoContext);
+}
+
+/**
+ * Liefert alle noch austehenden Infos zurück.
+ * Austehende Infos sind noch nicht als angezeigt markiert.
+ *
+ * @returns {[Info[], (displayedInfoId: string) => Promise<void>, () => void]}
+ * @example
+ * const [pendingInfos, setInfoDisplayed, refreshInfos] = usePendingInfos();
+ *
+ * setInfoDisplayed('1d3514da-37b1-49df-9bc1-7432a777c498');
+ *
+ * useEffect(
+ *     () => {
+ *         refreshInfos()
+ *     },
+ *     [refreshInfos]
+ * );
+ */
+export function usePendingInfos() {
+    const { pendingInfos, setInfoDisplayed, refreshInfos } = useInfoContext();
+
+    return [pendingInfos, setInfoDisplayed, refreshInfos];
+}

package/context/context-mails/MailService.js

@@ -0,0 +1,147 @@
+import { useSyncExternalStore } from 'react';
+
+import AsyncStorage from '@react-native-async-storage/async-storage';
+
+import TucUnseenApiProvider from './TucUnseenApiProvider';
+
+//class SubscribeableValue {
+//    #value;
+//
+//    #subscribers = new Set();
+//
+//    get value() {
+//        return this.#value
+//    }
+//
+//    set value(value) {
+//        this.#value = value;
+//
+//        this.#subscribers.forEach(subscriber => subscriber(this.#value));
+//    }
+//
+//    constructor(value) {
+//        this.#value = value;
+//    }
+//
+//    subscribe(subscriber) {
+//        return () => this.unsubscribe(subscriber);
+//    }
+//
+//    unsubscribe(subscriber) {
+//        return this.#subscribers.delete(subscriber);
+//    }
+//}
+
+/**
+ * @typedef ProviderSetting
+ * @property {string} provider Name des Providers
+ * @property {string} [url] Basis-URL des Provider für Web-Requests
+ */
+
+const UnreadEmailCountStoreKey = 'mails.unreadEmailCount';
+
+export default class MailService {
+    #provider;
+    #unreadEmailCount = undefined;
+    #unreadEmailCountSubscribers = new Set();
+
+    /**
+     *
+     * @param {*} provider Provider, der die Komunikation mit den Backend übernimmt
+     */
+    constructor(provider) {
+        this.#provider = provider;
+
+        AsyncStorage.getItem(UnreadEmailCountStoreKey)
+            .then(
+                unreadEmailCount => {
+                    if (this.#unreadEmailCount === undefined) {
+                        this.#unreadEmailCount = unreadEmailCount;
+                        this.#unreadEmailCountSubscribers.forEach(subscriber => subscriber());
+                    }
+                }
+            );
+
+        this.refreshUnreadEmailCount();
+    }
+
+    refreshUnreadEmailCount() {
+        return this.#provider
+            .getUnreadEmailCount()
+            .then(
+                unreadEmailCount => {
+                    AsyncStorage.setItem(UnreadEmailCountStoreKey, unreadEmailCount);
+                    this.#unreadEmailCount = unreadEmailCount;
+                    this.#unreadEmailCountSubscribers.forEach(subscriber => subscriber(unreadEmailCount));
+                }
+            );
+    }
+
+    refreshUnreadEmailCountCallback = () => this.refreshUnreadEmailCount();
+
+    unreadEmailCountSubscribe(subscriber) {
+        this.#unreadEmailCountSubscribers.add(subscriber);
+
+        return () => this.unreadEmailCountUnsubscribe(subscriber);
+    }
+
+    unreadEmailCountSubscribeCallback = subscriber => this.unreadEmailCountSubscribe(subscriber);
+
+    unreadEmailCountUnsubscribe(subscriber) {
+        return this.#unreadEmailCountSubscribers.delete(subscriber);
+    }
+
+    unreadEmailCount() {
+        return this.#unreadEmailCount;
+    }
+
+    unreadEmailCountCallback = () => this.unreadEmailCount();
+
+    /**
+     *
+     * @param {ProviderSetting} providerSettingsObject
+     * @param {string} language
+     * @param {string} accessToken
+     * @returns
+     */
+    static fromProviderSettingsObject(providerSettingsObject, language, accessToken) {
+        const provider = MailService.#createProvider(providerSettingsObject, language, accessToken);
+
+        return new MailService(provider);
+    }
+
+    /**
+     * @param {ProviderSetting} providerSettingsObject
+     */
+    static #createProvider(providerSettingsObject, language, accessToken) {
+        const { provider } = providerSettingsObject;
+
+        switch (provider) {
+            case TucUnseenApiProvider.name:
+                return TucUnseenApiProvider.fromSettingsObject(providerSettingsObject, language, accessToken);
+            default:
+                return null;
+        }
+    }
+}
+
+function nullUnreadEmailCountSubscribeCallback(subscriber) {
+    return () => { };
+}
+
+function nullUnreadEmailCountCallback() {
+    return undefined;
+}
+
+/**
+ *
+ * @param {MailService} mailService
+ */
+export function useUnreadEmailCount(mailService) {
+    const unreadEmailCount = useSyncExternalStore(
+        mailService?.unreadEmailCountSubscribeCallback ?? nullUnreadEmailCountSubscribeCallback,
+        mailService?.unreadEmailCountCallback ?? nullUnreadEmailCountCallback,
+    );
+
+    return [unreadEmailCount, mailService?.refreshUnreadEmailCountCallback];
+}

package/context/context-mails/TucUnseenApiProvider.js

@@ -0,0 +1,65 @@
+import HttpApiProvider, { JsonContentType } from '../../libraries/base-api-provider';
+
+/**
+ * Infos-API-Client für Kollektor
+ */
+export default class TucUnseenApiProvider extends HttpApiProvider {
+
+    /**
+     * @type {string} Name des Providers
+     */
+    static name = 'tuc-unseen';
+
+    /**
+     * Erstellt und gibt die abzufragende URL für ein ÖPNV-Ticket zurück.
+     *
+     * @returns {URL} URL für die Abfrage eines ÖPNV-Tickets.
+     */
+    getUnreadEmailCountUrl() {
+        const getUnreadEmailCountUrl = this.extendBaseUrl(['unseen']);
+
+        return getUnreadEmailCountUrl
+    }
+
+    /**
+     * Gibt die Anzahl der ungelesenen Mails.
+     *
+     * @returns {number} Anzahl der ungelesenen Mails.
+     */
+    getUnreadEmailCount() {
+        const getUnreadEmailCountUrl = this.getUnreadEmailCountUrl();
+
+        return this.get(getUnreadEmailCountUrl)
+            .then(response => response.json())
+            .then(jsonResponse => jsonResponse?.data?.unseen);
+    }
+
+    /**
+     * 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 {TucUnseenApiProvider} Erstellte CollektorVersion2ApiProvider-Instanz
+     */
+    static from(baseUrl, mainLanguage = 'de', accessToken) {
+        const acceptingLanguages = TucUnseenApiProvider.languagesFromMainLanguages(mainLanguage);
+        const acceptingContentTypes = HttpApiProvider.contentTypesFromContentType(JsonContentType);
+
+        return new TucUnseenApiProvider(baseUrl, acceptingLanguages, acceptingContentTypes, accessToken);
+    }
+
+    /**
+     * 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 {TucUnseenApiProvider} Erstellte CollektorVersion2ApiProvider-Instanz
+     */
+    static fromSettingsObject(settingsObject, mainLanguage = 'de', accessToken) {
+        const { url } = settingsObject;
+
+        return TucUnseenApiProvider.from(url, mainLanguage, accessToken);
+    }
+}

package/context/context-mails/index.js

@@ -0,0 +1,131 @@
+/**
+ * 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, use, useMemo, useEffect } from 'react';
+import { AppState } from 'react-native';
+
+import { useTheme } from 'react-native-paper';
+
+import { useLanguage, useStagingServer } from '../../libraries/core';
+import { useAccessToken } from '../context-user';
+
+import MailService, { useUnreadEmailCount as syncUnreadEmailCount } from './MailService';
+
+/**
+ * @typedef MailsContext
+ * @property {number} unreadEmailCount
+ * @property {() => Promise<void>} refreshUnreadEmailCount
+ */
+
+const MailsContext = createContext();
+
+/**
+ * Provider for mails context
+ */
+function MailsContextProvider({ children }) {
+    const theme = useTheme();
+    const isStagingServerActive = useStagingServer();
+    const language = useLanguage();
+    const accessToken = useAccessToken();
+
+    // Einstellungen für das ÖPNV-Ticket-Moduls
+    const mailsSettings = theme?.appSettings?.modules?.mails;
+    // Einstellungen für die API-Provider
+    const mailsApiSettings = mailsSettings?.api;
+    // Soll der Staging-Provider verwendet werden?
+    const mailsApiProviderSettings = isStagingServerActive
+        // Wenn ja, werden die Staging Provider-Einstellungen geladen
+        ? mailsApiSettings?.staging
+        // Wenn nein, werden die productiven Provider-Einstellungen geladen
+        : mailsApiSettings?.production;
+
+    const mailService = useMemo(
+        () =>
+            accessToken
+                ? MailService.fromProviderSettingsObject(
+                    mailsApiProviderSettings,
+                    language,
+                    accessToken,
+                )
+                : null,
+        [mailsApiProviderSettings, language, accessToken]
+    )
+
+    const [unreadEmailCount, refreshUnreadEmailCount] = syncUnreadEmailCount(mailService);
+
+    useEffect(
+        () => {
+            const subscription = AppState.addEventListener(
+                'change',
+                nextAppState => {
+                    if (nextAppState === 'active') {
+                        refreshUnreadEmailCount?.();
+                    }
+                }
+            );
+
+            return () => {
+                subscription.remove();
+            };
+        },
+        [refreshUnreadEmailCount]
+    );
+
+    return (
+        <MailsContext
+            value={{
+                unreadEmailCount,
+                refreshUnreadEmailCount,
+            }}
+        >
+            {children}
+        </MailsContext>
+    );
+}
+
+/**
+ * Liefert den MailsContext zurück.
+ * @return {MailsContext} Kontext des Mails-Modules
+ * @example
+ * const mailsContext = useMailsContext();
+ */
+function useMailsContext() {
+    return use(MailsContext);
+}
+
+/**
+ * Hook, der die Anzahl ungelesender Mails und eine Aktuallierungsfunktion zur Verfüfung stellt. 
+ * 
+ * @returns {[unreadEmailCount: number|undefined, refreshUnreadEmailCount: () => Promise<void>|undefined]}
+ * @example
+ * const [unreadEmailCount, refreshUnreadEmailCount] = useUrefreshUnreadEmailCount();
+ *
+ * useEffect(
+ *     () => {
+ *         refreshUnreadEmailCount?.()
+ *     },
+ *     [refreshUnreadEmailCount]
+ * );
+ */
+function useUnreadEmailCount() {
+    const mailsContext = useMailsContext();
+
+    return [mailsContext?.unreadEmailCount, mailsContext?.refreshUnreadEmailCount];
+}
+
+export {
+    useMailsContext as default,
+    MailsContextProvider,
+    useUnreadEmailCount,
+}

package/context/context-news/CollektorVersion2ApiProvider.js

@@ -0,0 +1,68 @@
+import HttpApiProvider from '../../libraries/base-api-provider';
+
+/**
+ * API-Client for Collector
+ */
+export default class CollektorVersion2ApiProvider extends HttpApiProvider {
+
+    /**
+     * @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 news channels from the collector.
+     * @returns {URL}
+     */
+    getNewsChannelsUrl() {
+        return this.extendBaseUrl(['feed']);
+    }
+
+    /**
+     * Returns a list of all news channels.
+     * @returns {Array} Array of all news channels.
+     */
+    getNewsChannels() {
+        const getNewsChannelsUrl = this.getNewsChannelsUrl();
+
+        return this.get(getNewsChannelsUrl)
+            .then(response => response.json());
+    }
+
+    /**
+     * Returns the request URL to get the news of a news channel from the collector.
+     * @param {String} newsChannelId Id of news channel.
+     * @returns {URL} URL of the news from the given news channel.
+     */
+    getNewsUrl(newsChannelId) {
+        return this.extendBaseUrl(['feed', newsChannelId]);
+    }
+
+    /**
+     * Returns a list of all news from the queried news channel.
+     * @param {String} newsChannelId Id of news channel.
+     * @returns {Array} Array of all news of the news channel.
+     */
+    getNews(newsChannelId) {
+        const getNewsUrl = this.getNewsUrl(newsChannelId);
+
+        return this.get(getNewsUrl)
+            .then(response => 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 {CollektorVersion2ApiProvider} Created CollectorVersion2ApiProvider instance.
+     */
+    static from(baseUrl, mainLanguage = 'de') {
+        const acceptingLanguages = CollektorVersion2ApiProvider.languagesFromMainLanguages(mainLanguage);
+
+        return new CollektorVersion2ApiProvider(baseUrl, acceptingLanguages);
+    }
+}