@selfcommunity/react-core 0.6.4-alpha.9 → 0.6.4-courses.102

package/lib/esm/hooks/useSCFetchLessonCommentObjects.js

@@ -0,0 +1,297 @@
+import { useEffect, useReducer } from 'react';
+import { SCOPE_SC_CORE } from '../constants/Errors';
+import { SCCommentsOrderBy } from '@selfcommunity/types';
+import { Endpoints, http } from '@selfcommunity/api-services';
+import { CacheStrategies, Logger, LRUCache } from '@selfcommunity/utils';
+import { getLessonCommentCacheKey, getLessonCommentsCacheKey } from '../constants/Cache';
+import { useIsComponentMountedRef } from '../utils/hooks';
+import { getCurrentPage } from '../utils/pagination';
+import useSCFetchLesson from '../hooks/useSCFetchLesson';
+/**
+ * @hidden
+ * We have complex state logic that involves multiple sub-values,
+ * so useReducer is preferable to useState.
+ * Define all possible auth action types label
+ * Use this to export actions and dispatch an action
+ */
+export const commentsObjectActionTypes = {
+    LOADING_NEXT: '_loading_next',
+    LOADING_PREVIOUS: '_loading_previous',
+    DATA_NEXT_LOADED: '_data_next_loaded',
+    DATA_PREVIOUS_LOADED: '_data_previous_loaded',
+    DATA_RELOAD: '_data_reload',
+    DATA_RELOADED: '_data_reloaded',
+    DATA_REVALIDATE: '_data_revalidate',
+};
+/**
+ * commentsReducer:
+ *  - manage the state of comments object
+ *  - update the state base on action type
+ * @param state
+ * @param action
+ */
+function commentsReducer(state, action) {
+    switch (action.type) {
+        case commentsObjectActionTypes.LOADING_NEXT:
+            return Object.assign(Object.assign({}, state), { isLoadingNext: true, isLoadingPrevious: false });
+        case commentsObjectActionTypes.LOADING_PREVIOUS:
+            return Object.assign(Object.assign({}, state), { isLoadingNext: false, isLoadingPrevious: true });
+        case commentsObjectActionTypes.DATA_NEXT_LOADED:
+            return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, state), { comments: action.payload.comments, isLoadingNext: false, componentLoaded: true, revalidate: false, revalidateNext: null, revalidatePrevious: null, next: action.payload.next }), (action.payload.page ? { page: action.payload.page } : {})), (action.payload.nextPage ? { nextPage: action.payload.nextPage } : {})), (action.payload.previous ? { previous: action.payload.previous } : {})), (action.payload.previousPage ? { previousPage: action.payload.previousPage } : {})), (action.payload.total ? { total: action.payload.total } : {}));
+        case commentsObjectActionTypes.DATA_PREVIOUS_LOADED:
+            return Object.assign(Object.assign(Object.assign(Object.assign({}, state), { comments: action.payload.comments, isLoadingPrevious: false, revalidate: false, revalidateNext: null, revalidatePrevious: null, previous: action.payload.previous }), (action.payload.page ? { page: action.payload.page } : {})), (action.payload.previousPage ? { previousPage: action.payload.previousPage } : {}));
+        case commentsObjectActionTypes.DATA_RELOAD:
+            return Object.assign(Object.assign({}, state), { next: action.payload.next, previousPage: null, nextPage: null, comments: [], total: 0, previous: null, isLoadingNext: true, reload: true });
+        case commentsObjectActionTypes.DATA_RELOADED:
+            return Object.assign(Object.assign({}, state), { componentLoaded: true, reload: false });
+        case commentsObjectActionTypes.DATA_REVALIDATE:
+            return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, state), { componentLoaded: true, revalidate: true }), (action.payload.revalidateNext ? { revalidateNext: action.payload.revalidateNext } : {})), (action.payload.revalidatePrevious ? { revalidatePrevious: action.payload.revalidatePrevious } : {})), { reload: false });
+        default:
+            throw new Error(`Unhandled type: ${action.type}`);
+    }
+}
+/**
+ * Define initial state
+ * @param data
+ */
+function stateInitializer(data) {
+    const __commentsObjectCacheKey = data.scLesson ? getLessonCommentsCacheKey(data.scLesson.id, data.next) : null;
+    let _initState = {
+        componentLoaded: false,
+        comments: [],
+        total: 0,
+        next: data.next,
+        previous: null,
+        isLoadingNext: false,
+        isLoadingPrevious: false,
+        page: Math.ceil(data.offset / data.pageSize + 1),
+        reload: false,
+        revalidate: false,
+        revalidateNext: null,
+        revalidatePrevious: null,
+    };
+    _initState['nextPage'] = _initState.next ? _initState.page + 1 : null;
+    _initState['previousPage'] = _initState.previous ? _initState.page - 1 : null;
+    if (__commentsObjectCacheKey && LRUCache.hasKey(__commentsObjectCacheKey) && data.cacheStrategy !== CacheStrategies.NETWORK_ONLY) {
+        const _cachedData = LRUCache.get(__commentsObjectCacheKey);
+        let page = Math.max(getCurrentPage(_cachedData.next, data.pageSize), 1);
+        const nextPage = _cachedData.next ? getCurrentPage(_cachedData.next, data.pageSize) : null;
+        const previousPage = _cachedData.previous ? Math.max(getCurrentPage(_cachedData.previous, data.pageSize) - 1, 1) : null;
+        return Object.assign(Object.assign({}, _initState), {
+            total: _cachedData.count,
+            next: _cachedData.next,
+            previous: _cachedData.previous,
+            comments: _cachedData.results,
+            page,
+            nextPage,
+            previousPage,
+            componentLoaded: true,
+        });
+    }
+    return _initState;
+}
+/**
+ :::info
+ This custom hooks is used to fetch paginated comments for a specific course lesson.
+ :::
+ * @param props
+ */
+export default function useSCFetchLessonCommentObjects(props) {
+    // PROPS
+    const { id, lessonObject, offset = 0, pageSize = 5, orderBy = SCCommentsOrderBy.ADDED_AT_DESC, parent, onChangePage, cacheStrategy = CacheStrategies.NETWORK_ONLY, } = props;
+    // FeedObject
+    const { scLesson, setSCLesson } = useSCFetchLesson({
+        id: id,
+        lesson: lessonObject,
+        courseId: lessonObject.course_id,
+        sectionId: lessonObject.section_id,
+        cacheStrategy,
+    });
+    /**
+     * Get next url
+     */
+    const getNextUrl = () => {
+        const _offset = offset ? `&offset=${offset}` : '';
+        const _parent = parent ? `&parent=${parent}` : '';
+        const _lessonId = scLesson ? scLesson.id : id;
+        const _courseId = scLesson ? scLesson.course_id : lessonObject.course_id;
+        const _sectionId = scLesson ? scLesson.section_id : lessonObject.section_id;
+        return `${Endpoints.GetCourseLessonComments.url({
+            id: _courseId,
+            section_id: _sectionId,
+            lesson_id: _lessonId,
+        })}?limit=${pageSize}&ordering=${orderBy}${_offset}${_parent}`;
+    };
+    // STATE
+    const [state, dispatch] = useReducer(commentsReducer, { scLesson, offset, pageSize, next: getNextUrl(), cacheStrategy }, stateInitializer);
+    // REFS
+    const isMountedRef = useIsComponentMountedRef();
+    /**
+     * Get Comments (with cache)
+     */
+    const revalidate = (url, forward) => {
+        return performFetchComments(url, false).then((res) => {
+            let _comments;
+            let page = getCurrentPage(forward ? res.next : res.previous, pageSize);
+            if (forward) {
+                let start = state.comments.slice(0, state.comments.length - res.results.length);
+                _comments = start.concat(res.results);
+            }
+            else {
+                let start = state.comments.slice(res.results.length, state.comments.length);
+                _comments = res.results.concat(start);
+            }
+            if (isMountedRef.current) {
+                dispatch({
+                    type: forward ? commentsObjectActionTypes.DATA_NEXT_LOADED : commentsObjectActionTypes.DATA_PREVIOUS_LOADED,
+                    payload: Object.assign(Object.assign({ page, comments: _comments }, (forward ? { next: res.next } : { previous: res.previous })), { total: res.count }),
+                });
+            }
+        });
+    };
+    /**
+     * Get Comments
+     */
+    const performFetchComments = (url, seekCache = true) => {
+        const __commentObjectsCacheKey = getLessonCommentsCacheKey(scLesson.id, url);
+        if (seekCache && LRUCache.hasKey(__commentObjectsCacheKey) && cacheStrategy !== CacheStrategies.NETWORK_ONLY) {
+            return Promise.resolve(LRUCache.get(__commentObjectsCacheKey));
+        }
+        return http
+            .request({
+            url,
+            method: Endpoints.GetCourseLessonComments.method,
+        })
+            .then((res) => {
+            if (res.status >= 300) {
+                return Promise.reject(res);
+            }
+            LRUCache.set(__commentObjectsCacheKey, res.data);
+            res.data.results.forEach((e) => LRUCache.set(getLessonCommentCacheKey(e.id), e));
+            return Promise.resolve(res.data);
+        });
+    };
+    /**
+     * Fetch previous comments
+     */
+    function getPreviousPage() {
+        if (scLesson && state.previous && !state.isLoadingPrevious) {
+            const _previous = state.previous;
+            dispatch({ type: commentsObjectActionTypes.LOADING_PREVIOUS });
+            performFetchComments(_previous)
+                .then((res) => {
+                if (isMountedRef.current) {
+                    let currentPage = getCurrentPage(_previous, pageSize);
+                    let previousPage = res.previous ? currentPage - 1 : null;
+                    dispatch({
+                        type: commentsObjectActionTypes.DATA_PREVIOUS_LOADED,
+                        payload: {
+                            page: currentPage,
+                            previousPage,
+                            comments: [...res.results, ...state.comments],
+                            previous: res.previous,
+                        },
+                    });
+                    onChangePage && onChangePage(currentPage);
+                }
+            })
+                .catch((error) => {
+                Logger.error(SCOPE_SC_CORE, error);
+            })
+                .then(() => {
+                if (isMountedRef.current && cacheStrategy === CacheStrategies.STALE_WHILE_REVALIDATE) {
+                    dispatch({ type: commentsObjectActionTypes.DATA_REVALIDATE, payload: { revalidatePrevious: _previous } });
+                }
+            });
+        }
+    }
+    /**
+     * Fetch next comments
+     */
+    function getNextPage() {
+        if (scLesson && state.next && !state.isLoadingNext) {
+            const _next = state.next;
+            dispatch({ type: commentsObjectActionTypes.LOADING_NEXT });
+            performFetchComments(_next)
+                .then((res) => {
+                if (isMountedRef.current) {
+                    let currentPage = getCurrentPage(_next, pageSize);
+                    let nextPage = res.next ? currentPage + 1 : null;
+                    dispatch({
+                        type: commentsObjectActionTypes.DATA_NEXT_LOADED,
+                        payload: Object.assign({ page: currentPage, nextPage, comments: [...state.comments, ...res.results], next: res.next, total: res.count, componentLoaded: true }, (offset && state.comments.length === 0 ? { previous: res.previous, previousPage: res.previous ? currentPage - 1 : null } : {})),
+                    });
+                    onChangePage && onChangePage(currentPage);
+                }
+            })
+                .catch((error) => {
+                Logger.error(SCOPE_SC_CORE, error);
+            })
+                .then(() => {
+                if (isMountedRef.current && cacheStrategy === CacheStrategies.STALE_WHILE_REVALIDATE) {
+                    dispatch({ type: commentsObjectActionTypes.DATA_REVALIDATE, payload: { revalidateNext: _next } });
+                }
+            });
+        }
+    }
+    /**
+     * Reset component status on change orderBy, pageSize, offset
+     */
+    const reload = () => {
+        if (isMountedRef.current && state.componentLoaded && Boolean(scLesson) && !state.isLoadingNext && !state.reload) {
+            dispatch({
+                type: commentsObjectActionTypes.DATA_RELOAD,
+                payload: {
+                    next: getNextUrl(),
+                },
+            });
+        }
+    };
+    /**
+     * Reload fetch comments
+     */
+    useEffect(() => {
+        if (isMountedRef.current && state.componentLoaded && state.reload && !state.isLoadingNext && !state.isLoadingPrevious) {
+            dispatch({
+                type: commentsObjectActionTypes.DATA_RELOADED,
+            });
+            getNextPage();
+        }
+    }, [state.reload, isMountedRef]);
+    /**
+     * Revalidate last fetched comments
+     */
+    useEffect(() => {
+        if (isMountedRef.current && state.componentLoaded && Boolean(scLesson) && !state.reload && state.revalidate) {
+            revalidate(state.revalidateNext, Boolean(state.revalidateNext));
+        }
+    }, [state.revalidate, isMountedRef]);
+    /**
+     * Update lesson comments list
+     * @param updatedData
+     */
+    const updateLessonComments = (updatedData) => {
+        if (updatedData) {
+            dispatch({
+                type: commentsObjectActionTypes.DATA_NEXT_LOADED,
+                payload: {
+                    comments: updatedData,
+                    next: state.next,
+                    total: updatedData.length,
+                },
+            });
+            const __commentsCacheKey = getLessonCommentsCacheKey(scLesson.id, state.next);
+            LRUCache.set(__commentsCacheKey, updatedData.map((comment) => {
+                const __commentCacheKey = getLessonCommentCacheKey(comment.id);
+                LRUCache.set(__commentCacheKey, comment);
+                return comment.id;
+            }));
+        }
+    };
+    return Object.assign(Object.assign({ lessonObject: scLesson, setLessonObject: setSCLesson }, state), { pageSize,
+        getNextPage,
+        getPreviousPage,
+        orderBy,
+        reload,
+        updateLessonComments });
+}

package/lib/esm/hooks/useSCFetchLiveStream.d.ts

@@ -0,0 +1,20 @@
+import { SCLiveStreamType } from '@selfcommunity/types';
+import { CacheStrategies } from '@selfcommunity/utils';
+/**
+ :::info
+ This custom hook is used to fetch an liveStream object.
+ :::
+ * @param object
+ * @param object.id
+ * @param object.liveStream
+ * @param object.cacheStrategy
+ */
+export default function useSCFetchLiveStream({ id, liveStream, cacheStrategy, }: {
+    id?: number | string;
+    liveStream?: SCLiveStreamType;
+    cacheStrategy?: CacheStrategies;
+}): {
+    scLiveStream: SCLiveStreamType;
+    setSCLiveStream: (e: SCLiveStreamType) => void;
+    error: string;
+};

package/lib/esm/hooks/useSCFetchLiveStream.js

@@ -0,0 +1,73 @@
+import { Endpoints, http } from '@selfcommunity/api-services';
+import { CacheStrategies, Logger, LRUCache, objectWithoutProperties } from '@selfcommunity/utils';
+import { useEffect, useMemo, useState } from 'react';
+import { useDeepCompareEffectNoCheck } from 'use-deep-compare-effect';
+import { useSCUser } from '../components/provider/SCUserProvider';
+import { getLiveStreamObjectCacheKey } from '../constants/Cache';
+import { SCOPE_SC_CORE } from '../constants/Errors';
+/**
+ :::info
+ This custom hook is used to fetch an liveStream object.
+ :::
+ * @param object
+ * @param object.id
+ * @param object.liveStream
+ * @param object.cacheStrategy
+ */
+export default function useSCFetchLiveStream({ id = null, liveStream = null, cacheStrategy = CacheStrategies.CACHE_FIRST, }) {
+    const __eventId = liveStream ? liveStream.id : id;
+    // CONTEXT
+    const scUserContext = useSCUser();
+    const authUserId = scUserContext.user ? scUserContext.user.id : null;
+    // CACHE
+    const __liveStreamCacheKey = getLiveStreamObjectCacheKey(__eventId);
+    const __liveStream = authUserId ? liveStream : objectWithoutProperties(liveStream, ['subscription_status']);
+    const [scLiveStream, setScLiveStream] = useState(cacheStrategy !== CacheStrategies.NETWORK_ONLY ? LRUCache.get(__liveStreamCacheKey, __liveStream) : null);
+    const [error, setError] = useState(null);
+    /**
+     * Memoized setSCLiveStream (auto-subscription if need it)
+     */
+    const setSCLiveStream = useMemo(() => (e) => {
+        setScLiveStream(e);
+        LRUCache.set(__liveStreamCacheKey, e);
+    }, [authUserId, setScLiveStream]);
+    /**
+     * Memoized fetchTag
+     */
+    const fetchLiveStream = useMemo(() => (id) => {
+        return http
+            .request({
+            url: Endpoints.GetLiveStreamInfo.url({ id }),
+            method: Endpoints.GetLiveStreamInfo.method,
+        })
+            .then((res) => {
+            if (res.status >= 300) {
+                return Promise.reject(res);
+            }
+            return Promise.resolve(res.data);
+        });
+    }, []);
+    /**
+     * If id attempt to get the liveStream by id
+     */
+    useEffect(() => {
+        if (id !== null && id !== undefined && !liveStream) {
+            fetchLiveStream(id)
+                .then((e) => {
+                setSCLiveStream(e);
+            })
+                .catch((err) => {
+                LRUCache.delete(__liveStreamCacheKey);
+                setError(`LiveStream with id ${id} not found`);
+                Logger.error(SCOPE_SC_CORE, `LiveStream with id ${id} not found`);
+                Logger.error(SCOPE_SC_CORE, err.message);
+            });
+        }
+    }, [id, liveStream, authUserId]);
+    useDeepCompareEffectNoCheck(() => {
+        if (liveStream) {
+            setSCLiveStream(liveStream);
+        }
+    }, [liveStream, authUserId]);
+    return { scLiveStream, setSCLiveStream, error };
+}

package/lib/esm/hooks/useSCJoinedCoursesManager.d.ts

@@ -0,0 +1,38 @@
+import { SCCourseType, SCUserType } from '@selfcommunity/types';
+/**
+ :::info
+ This custom hook is used to manage the courses followed.
+ :::
+
+ :::tip How to use it:
+ Follow these steps:
+ ```jsx
+ 1. const scUserContext: SCUserContextType = useSCUser();
+ 2. const scJoinedCoursesManager: SCJoinedCoursesManagerType = scUserContext.manager.courses;
+ 3. scJoinedCoursesManager.isJoined(course)
+ ```
+ :::
+ */
+export default function useSCJoinedCoursesManager(user?: SCUserType): {
+    courses: any[];
+    loading: any[];
+    isLoading: (v: number | {
+        id: number;
+    }) => boolean;
+    join?: undefined;
+    leave?: undefined;
+    joinStatus?: undefined;
+    refresh?: undefined;
+    emptyCache?: undefined;
+} | {
+    courses: any[];
+    loading: any[];
+    isLoading: (v: number | {
+        id: number;
+    }) => boolean;
+    join: (course: SCCourseType, userId?: number) => Promise<any>;
+    leave: (course: SCCourseType) => Promise<any>;
+    joinStatus: (course: SCCourseType) => string;
+    refresh: () => void;
+    emptyCache: () => void;
+};