@olea-bps/base 1.0.0

package/index.js

@@ -0,0 +1,178 @@
+
+// Exports Components
+
+export { default as AppBar } from './components/AppBar';
+export { default as BookDetail } from './components/BookDetail';
+export { default as ConnectivityWarning } from './components/ConnectivityWarning';
+export { default as ContactDetail } from './components/ContactDetail';
+export { default as CourseDetail } from './components/CourseDetail';
+export { default as CourseDetailDialog } from './components/CourseDetailDialog';
+export { default as CourseInfo } from './components/CourseInfo';
+export { default as DevelopmentDialog } from './components/DevelopmentDialog';
+export { default as EventCodeInput } from './components/EventCodeInput';
+export { default as FlexMenuEntry } from './components/FlexMenuEntry';
+export { default as MainMenuEntry } from './components/MainMenuEntry';
+export { default as MealItem } from './components/MealItem';
+export { default as MensaMenu } from './components/MensaMenu';
+export { default as MensaSlider } from './components/MensaSlider';
+export { default as Modal } from './components/Modal';
+export { default as NewsDetail } from './components/NewsDetail';
+export { default as NewsList } from './components/NewsList';
+export { default as NewsListItem } from './components/NewsListItem';
+export { default as OtherCourses } from './components/OtherCourses';
+export { default as PtsDeparture } from './components/PtsDeparture';
+export { default as PtsStation } from './components/PtsStation';
+export { default as QuickLinks } from './components/QuickLinks';
+export { default as RoomDetail } from './components/RoomDetail';
+export { default as ScaledImage } from './components/ScaledImage';
+export { default as SearchResults } from './components/SearchResults';
+export { default as SettingSection } from './components/SettingSection';
+export { default as SettingsDialog } from './components/SettingsDialog';
+export { default as SettingsDialogRadio } from './components/SettingsDialogRadio';
+export { default as SettingsDialogSelect } from './components/SettingsDialogSelect';
+export { default as TimetableCodeInput } from './components/TimetableCodeInput';
+export { default as TimetableDay } from './components/TimetableDay';
+export { default as TimetableEvent } from './components/TimetableEvent';
+export { default as TimetableListComponent } from './components/TimetableList';
+export { default as TimetableMonth } from './components/TimetableMonth';
+export { default as TimetableWeek } from './components/TimetableWeek';
+export { default as TopNews } from './components/TopNews';
+export { default as TopNewsHtwk } from './components/TopNewsHtwk';
+export { default as WebView } from './components/WebView';
+export { default as ComponentJobsFilter } from './components/ComponentJobsFilter';
+
+// Exports Views
+
+export { default as Callmanager } from './views/Callmanager';
+export { default as Canteens } from './views/Canteens';
+export { default as Dashboard } from './views/Dashboard';
+export { default as DashboardHtwk } from './views/DashboardHtwk';
+export { default as Event } from './views/Event';
+export { default as FeedList } from './views/FeedList';
+export { default as FeedNews } from './views/FeedNews';
+export { default as Flexmenu } from './views/Flexmenu';
+export { default as FlexmenuWebview } from './views/FlexmenuWebview';
+export { default as Howhy } from './views/Howhy';
+export { default as Jobs } from './views/Jobs';
+export { default as MainMenu } from './views/MainMenu';
+export { default as NewsTabbar } from './views/NewsTabbar';
+export { default as Opal } from './views/Opal';
+export { default as PublicTransportTicket } from './views/PublicTransportTicket';
+export { default as Search } from './views/Search';
+export { default as SettingsAccessibility } from './views/SettingsAccessibility';
+export { default as SettingsAppInfo } from './views/SettingsAppInfo';
+export { default as SettingsCanteens } from './views/SettingsCanteens';
+export { default as SettingsGeneral } from './views/SettingsGeneral';
+export { default as SettingsNotifications } from './views/SettingsNotifications';
+export { default as SettingsUser } from './views/SettingsUser';
+export { default as TimetableCalendar } from './views/TimetableCalendar';
+export { default as TimetableListView } from './views/TimetableList';
+export { default as Webviews } from './views/Webviews';
+
+// Exports Contexts
+
+export {
+    default as CallManagerContext,
+    CallManagerContextProvider,
+    useCallManagerContext,
+    useParallelCalls,
+} from './context/context-callmanager';
+
+export {
+    default as CanteenContext,
+    CanteenContextProvider,
+    useCanteenContext,
+    useCanteens,
+    useCanteen,
+    useMenu,
+    useFilteredMenu,
+    usePriceGroupCode,
+    useFavoriteCanteens,
+} from './context/context-canteen';
+
+export {
+    ConnectivityContext,
+    ConnectivityContextProvider,
+    useConnectivityContext,
+    useNetInfo,
+} from './context/context-connectivity';
+
+export {
+    EventContext,
+    default as EventContextProvider,
+    useEventContext,
+    usePersonalEvents,
+    useEvents,
+    usePersonalEventsCode,
+    useEventApiClient,
+} from './context/context-event';
+
+export {
+    default as FlexMenuContext,
+    FlexMenuContextProvider,
+    useFlexMenuContext,
+    useMenuEntries,
+    useChildMenuEntries,
+    useMainMenuEntries,
+} from './context/context-flex-menu';
+
+export {
+    default as useMailsContext,
+    MailsContextProvider,
+    useUnreadEmailCount,
+} from './context/context-mails';
+
+export {
+    default as NewsContext,
+    NewsContextProvider,
+    useNewsContext,
+    useApiProvider,
+    useNewsChannels,
+} from './context/context-news';
+
+export {
+    PublicTransportTicketContextProvider,
+    usePublicTransportTicketContext,
+    usePublicTransportTicket,
+} from './context/context-public-transport-ticket';
+
+export {
+    default as TimetableContext,
+    TimetableContextProvider,
+    weekModes as CourseWeekModes,
+    useTimetableCode,
+    useCourses,
+    useDateCourses,
+    TimetableNotFoundError,
+} from './context/context-timetable';
+
+export {
+    default as UserContext,
+    UserContextProvider,
+    useUserContext,
+    useAccessToken,
+    useIdToken,
+    useUser,
+    useLogoutEffect,
+} from './context/context-user';
+
+// Exports Contexts libraries
+
+export {
+    default as HttpApiProvider,
+    JsonContentType,
+} from './libraries/base-api-provider';
+
+export * from './libraries/core';
+
+export * from './libraries/core-plugins';
+
+export {
+    default as IconsOpenasist,
+} from './libraries/icons-openasist';
+
+export {
+    default as OpenASiSTNotifications,
+} from './libraries/notifications';
+
+export * from './libraries/stored-state';

package/libraries/base-api-provider/hooks.js

@@ -0,0 +1,24 @@
+import { useMemo } from 'react';
+
+import { useTheme } from 'react-native-paper';
+
+import { useIdToken, useAccessToken } from '../../context/context-user';
+
+export function useProvider(provider, providersInitializers) {
+    const theme = useTheme();
+    const appSettings = theme?.appSettings;
+    const accessToken = useAccessToken();
+    const idToken = useIdToken();
+    const providerInitializer = providersInitializers?.[provider];
+
+    return useMemo(
+        () => {
+            return providerInitiliser?.({
+                appSettings,
+                accessToken,
+                idToken,
+            })
+        },
+        [provider, providerInitializer, appSettings, accessToken, idToken]
+    )
+}

package/libraries/base-api-provider/http-api-provider.js

@@ -0,0 +1,168 @@
+/**
+ * API-Client/-Provider der die Grundlage für HTTP/REST bassierte API-Clienten/-Provider benutzt werden kann.
+ */
+export default class HttpApiProvider {
+    /**
+     * Base URL which is expanded to generate the request URLs.
+     * @type {string}
+     * @private
+     */
+    #baseUrl
+
+    /**
+     * Prioritised language of retrieved data
+     * @type {string[]}
+     * @private
+     */
+    #acceptingLanguages
+
+    /**
+     * Content types requested by the server
+     * @type {string[]}
+     * @private
+     */
+    #acceptingContentTypes
+
+    /**
+     * Access token for authentication
+     * @type {string}
+     * @private
+     */
+    #accessToken
+
+    /**
+     * Construct a REST API provder.
+     * @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.
+     * @param {string[]} acceptingContentTypes - List of content types that are queried by the ASiST server. The priority is based on the order of the content types in the array.
+     * @param {string} [accessToken=null] OIDC access token which is used for authentication against the API. Default is null
+     */
+    constructor(baseUrl, acceptingLanguages, acceptingContentTypes, accessToken = null) {
+        this.#baseUrl = baseUrl;
+        this.#acceptingLanguages = acceptingLanguages;
+        this.#acceptingContentTypes = acceptingContentTypes;
+        this.#accessToken = accessToken;
+    }
+
+    /**
+     * Creates a new URL from the base URL and the transferred path segments.
+     * @param {string[]} pathSegments - Path segments that are added to the base URL.
+     * @returns Base URL extended by segments.
+     */
+    extendBaseUrl(pathSegments = []) {
+        return new URL(pathSegments.join('/'), this.#baseUrl);
+    }
+
+    /**
+     * Executes a get request to the passed URL.
+     * @param {string|URL} url - URL on which a GET request is executed.
+     * @param {object} headers - Headers that are appended to the HTTP request.
+     * @returns {Promise<Response>} Promise with the response to the GET request from the server.
+     */
+    get(url, headers = {}) {
+        return fetch(
+            url,
+            {
+                headers: {
+                    // Headers des Parameters 'header = {}' werden mit dem Standart-Headern zusammengeführt.
+                    // Dabei haben Standart-Header höhere Priorität, da diese die Parameter-Header überschreiben.
+                    ...headers,
+                    ...HttpApiProvider.generateHeaders(
+                        this.#acceptingLanguages,
+                        this.#acceptingContentTypes,
+                        this.#accessToken,
+                    )
+                },
+            },
+        );
+    }
+
+    patch(url, body, headers = null) {
+        const jsonBody = JSON.stringify(body);
+
+        console.debug(this.constructor.name, ':', 'Send PATCH to', url, 'with content', ':', jsonBody);
+
+        return fetch(
+            url,
+            {
+                method: 'PATCH',
+                headers: {
+                    // Headers des Parameters 'header = {}' werden mit dem Standart-Headern zusammengeführt.
+                    // Dabei haben Standart-Header höhere Priorität, da diese die Parameter-Header überschreiben.
+                    ...headers,
+                    ...HttpApiProvider.generateHeaders(
+                        this.#acceptingLanguages,
+                        this.#acceptingContentTypes,
+                        this.#accessToken,
+                    ),
+                    'Content-Type': JsonContentType,
+                },
+                body: jsonBody,
+            },
+        );
+    }
+
+    /**
+     * Returns standart headers für asist server requests.
+     * @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.
+     * @param {string[]} acceptingContentTypes - List of the MIME types to be queried by the HTTP API.
+     * @param {string} [accessToken=null] OIDC access token which is used for authentication against the API. Default is null.
+     * @returns {object} object, which contains the name of the header as the key and the value of the key is the value of the header.
+     */
+    // If available implement as private
+    static generateHeaders(acceptingLanguages, acceptingContentTypes, accessToken = null) {
+
+        const accessTokenHeader = accessToken ? HttpApiProvider.generateBearerHeader(accessToken) : null;
+
+        return {
+            'Accept': HttpApiProvider.generateHeaderValueFromList(acceptingContentTypes), // Wir wollen JSON zugesendet bekommen
+            'Accept-Language': HttpApiProvider.generateHeaderValueFromList(acceptingLanguages), // Wir wollen die Hauptsprache priorisieren
+            ...accessTokenHeader,
+        }
+    }
+
+    static generateBearerHeader(accessToken) {
+        return { 'Authorization': `Bearer ${accessToken}` };
+    }
+
+    /**
+     * Converts a list of string values into a string that symbolises a list of header values.
+     * @param {string[]} headerValueList - List of strings to convert.
+     * @returns String expressing a header value list.
+     */
+    static generateHeaderValueFromList(headerValueList) {
+        return headerValueList?.join(', ') ?? null;
+    }
+
+    static contentTypesFromContentType(contentTyp) {
+        return [contentTyp];
+    }
+
+    /**
+     * Creates an array with language codes depending on the passed main language.
+     * @param {string} mainLanguage - Main language which is prioritised.
+     * @returns {string[]} List of language codes, with the main language taking priority.
+     */
+    static languagesFromMainLanguages(mainLanguage) {
+        // Erstellen der Liste an Sprachen anhand der Hauptsprache(mainLanguage)
+
+        // Prüfen des Sprachparameters
+        switch (mainLanguage) {
+            case 'de':
+                // Wenn Deutsch die Hauptsprache ist, wird Deutsch und nachrangig Englisch als Sprachen ausgewählt
+                return ['de', 'en'];
+            case 'en':
+                // Wenn English die Hauptsprache ist, wird English und nachrangig Deutsch als Sprachen ausgewählt
+                return ['en', 'de'];
+            default:
+                // Wenn Hauptsprache nicht bekannt, wird die Hauptsprache, nachrangig Deutsch und nachrangiger English als Sprachen ausgewählt
+                return [mainLanguage, 'de', 'en'];
+        }
+    }
+}
+
+export const JsonContentType = 'application/json';
+
+export const ContentTypes = {
+    json: JsonContentType,
+};

package/libraries/base-api-provider/index.js

@@ -0,0 +1,20 @@
+/**
+ * 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 HttpApiProvider, { JsonContentType } from './http-api-provider.js';
+
+export {
+    HttpApiProvider as default,
+    JsonContentType,
+}

package/libraries/core/api/canteens.js

@@ -0,0 +1,88 @@
+
+//------------------------------------
+// canteen : Canteens of university
+// -----------------------------------
+
+import { ApiSettings, GETOptions, GETOptionsByLanguage } from '../constants/api';
+import {action, commitAction, rollbackAction} from "./../constants/actions";
+import { store } from '../redux/store';
+
+export const canteensApi = {
+
+    /**
+     * Get all canteens with their menus
+     */
+    getAll: (res) => {
+        let url = ApiSettings.getApiUrl(ApiSettings.canteen.getAll);
+        fetch(url, GETOptions)
+            .then((response) => response.json())
+            .then((resJson) => {
+                if(resJson.canteens) {
+                    res(resJson.canteens);
+                }
+            })
+            .catch((error) => {
+                console.warn('Error Code: 1003 : ' + error);
+                res(null);
+            })
+    },
+
+
+    /**
+     * Get all canteens with their menus of date {date} with format 'yyyy-MM-dd'
+     *
+     * @param date
+     * @param res
+     */
+    getByDate: (date, res) => {
+        let url = ApiSettings.getApiUrl(ApiSettings.canteen.getByDate);
+        url = url.replace('{date}', date);
+
+        fetch(url, GETOptions)
+            .then((response) => response.json())
+            .then((resJson) => {
+                res(resJson);
+            })
+            .catch((error) => {
+                console.warn('Error Code: 1004 : ' + error);
+                res(null);
+            })
+    }
+};
+
+
+// REDUX - OFFLINE
+
+const defaultType = action.canteen.getAll;
+
+export const updateTodayMeals = () => {
+
+    const language = store.getState().settingReducer.settingsGeneral.language;
+    const headers = GETOptionsByLanguage(language).headers;
+    return {
+        type: defaultType,
+        meta: {
+            offline: {
+                effect: { url: ApiSettings.getApiUrl(ApiSettings.canteen.getAll), method: 'GET', headers},
+                commit: { type: defaultType + commitAction },
+                rollback: { type: defaultType + rollbackAction }
+            }
+        }
+    };
+};
+
+export const updateAllMeals = () => {
+    const language = store.getState().settingReducer.settingsGeneral.language;
+    const headers = GETOptionsByLanguage(language).headers;
+
+    return {
+        type: action.canteen.getAll,
+        meta: {
+            offline: {
+                effect: { url: ApiSettings.getApiUrl(ApiSettings.canteen.getAll), method: 'GET', headers },
+                commit: { type: action.canteen.getAll + commitAction },
+                rollback: { type: action.canteen.getAll + rollbackAction }
+            }
+        }
+    };
+};

package/libraries/core/api/corona.js

@@ -0,0 +1,45 @@
+
+//------------------------------------
+// canteen : Canteens of university
+// -----------------------------------
+
+import {ApiSettings, GETOptions} from '../constants/api';
+import {action, commitAction, rollbackAction} from "../constants/actions";
+
+export const coronaApi = {
+
+    /**
+     * Get corona menu
+     */
+    getCoronaMenu: (res) => {
+        let url = ApiSettings.getApiUrl(ApiSettings.corona.getCoronaMenu)
+
+        fetch(url, GETOptions)
+            .then((response) => response.json())
+            .then((resJson) => {
+                if(resJson) {
+                    res(resJson);
+                }
+            })
+            .catch((error) => {
+                console.warn('Error Code: 1005 : ' + error);
+                res(null);
+            })
+    }
+};
+
+
+// REDUX - OFFLINE
+
+const defaultType = action.corona.getCoronaMenu;
+
+export const updateCoronaMenu = () => ({
+    type: defaultType,
+    meta: {
+        offline: {
+            effect: { url: ApiSettings.getApiUrl(ApiSettings.corona.getCoronaMenu), method: 'GET' },
+            commit: { type: defaultType + commitAction },
+            rollback: { type: defaultType + rollbackAction }
+        }
+    }
+});

package/libraries/core/api/courses.js

@@ -0,0 +1,54 @@
+
+//------------------------------------
+// course : Courses of university
+// -----------------------------------
+
+import {ApiSettings, GETOptions} from '../constants/api';
+import {action, commitAction, rollbackAction} from "./../constants/actions";
+
+const defaultType = action.coursesV2.getCourses;
+
+export const coursesApi = {
+
+    /**
+     * Get courses by short code and device id
+     */
+    getCourses: (timetableCode, res) => {
+        let url = ApiSettings.getApiUrl(ApiSettings.coursesV2.getCourses);
+        url = url.replace('{timetableCode}', timetableCode);
+
+        fetch(url, GETOptions)
+            .then((response) => response.json())
+            .then((resJson) => {
+                res(resJson);
+            })
+            .catch((error) => {
+                console.warn('Error Code: 1006 : ' + error);
+                res(null);
+            })
+    }
+};
+
+
+// REDUX - OFFLINE
+
+export const updateCourses = (timetableCode, hideErrors) => {
+    const headers = GETOptions.headers;
+    let url = ApiSettings.getApiUrl(ApiSettings.coursesV2.getCourses);
+    url = url.replace('{timetableCode}', timetableCode);
+
+    return {
+        type: defaultType,
+        meta: {
+            offline: {
+                effect: {
+                    url,
+                    method: 'GET',
+                    headers
+                },
+                commit: { type: defaultType + commitAction },
+                rollback: { type: defaultType + rollbackAction, hideErrors }
+            }
+        }
+    }
+};

package/libraries/core/api/device.js

@@ -0,0 +1,98 @@
+
+//------------------------------------
+// device : Registration service for devices
+// -----------------------------------
+
+import {ApiSettings, POSTOptions} from '../constants/api';
+import {action, commitAction, rollbackAction} from "./../constants/actions";
+import {Platform} from 'react-native';
+
+export const deviceApi = {
+
+
+    /**
+     * Resgister a new device
+     */
+    postRegisterDevice: (type, res) => {
+        let url = ApiSettings.getApiUrl(ApiSettings.device.postRegisterDevice);
+        url = url.replace('{type}', type);
+
+        fetch(url, POSTOptions)
+            .then((response) => response.json())
+            .then((resJson) => {
+                res(resJson);
+            })
+            .catch((error) => {
+                console.warn('Error Code: 1007 : ' + error);
+                res(null);
+            })
+    },
+
+    /**
+     * Post lms
+     */
+    postLMS: (pushUid, res) => {
+        let url = ApiSettings.getApiUrl(ApiSettings.device.postLMS);
+        url = url.replace('{pushuid}', pushUid);
+
+        fetch(url, POSTOptions)
+            .then((response) => response.json())
+            .then((resJson) => {
+                res(resJson);
+            })
+            .catch((error) => {
+                console.warn('Error Code: 1008 : ' + error);
+                res(null);
+            })
+    },
+
+    /**
+     * Post device settings
+     */
+    postSettings: (module, value, res) => {
+        let url = ApiSettings.getApiUrl(ApiSettings.device.postSettings);
+        url = url.replace('{module}', module);
+        url = url.replace('{value}', value);
+
+        fetch(url, POSTOptions)
+            .then((response) => response.json())
+            .then((resJson) => {
+                res(resJson);
+            })
+            .catch((error) => {
+                console.warn('Error Code: 1009 : ' + error);
+                res(null);
+            })
+    }
+};
+
+
+
+// REDUX - OFFLINE
+
+const defaultType = action.device.postRegisterDevice;
+const generateToken = () => {
+    let token = '';
+  for (var i = 0; i <= 1; i++) {
+        token += Math.random().toString(36).substr(2);
+    }
+    return token;
+};
+
+
+export const registerDevice = () => ({
+    type: defaultType,
+    meta: {
+        offline: {
+            effect: {
+                url: ApiSettings.getApiUrl(ApiSettings.device.postRegisterDevice),
+                method: 'POST',
+                body: 'token='+ generateToken() + '&type=' + (Platform.OS === 'ios' ? 'IOS' : 'ANDROID'),
+                headers: { 'content-type': 'application/x-www-form-urlencoded' }
+            },
+            commit: { type: defaultType + commitAction },
+            rollback: { type: defaultType + rollbackAction }
+        }
+    }
+});
+