@selfcommunity/react-ui 0.11.0-alpha.9 → 0.11.0-alpha.91

package/lib/esm/components/UserCreatedCoursesWidget/UserCreatedCoursesWidget.js

@@ -0,0 +1,148 @@
+import { __rest } from "tslib";
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import React, { useEffect, useMemo, useReducer, useState } from 'react';
+import { Button, CardContent, ListItem, Typography, styled, List } from '@mui/material';
+import { CourseService } from '@selfcommunity/api-services';
+import { CacheStrategies, isInteger, Logger } from '@selfcommunity/utils';
+import { SCCache, SCPreferences, useSCPreferences, useSCUser } from '@selfcommunity/react-core';
+import { actionWidgetTypes, dataWidgetReducer, stateWidgetInitializer } from '../../utils/widget';
+import { SCCourseJoinStatusType, SCFeatureName } from '@selfcommunity/types';
+import { SCOPE_SC_UI } from '../../constants/Errors';
+import { FormattedMessage } from 'react-intl';
+import Skeleton from './Skeleton';
+import classNames from 'classnames';
+import BaseDialog from '../../shared/BaseDialog';
+import Widget from '../Widget';
+import { useThemeProps } from '@mui/system';
+import HiddenPlaceholder from '../../shared/HiddenPlaceholder';
+import { PREFIX } from './constants';
+import Course, { CourseSkeleton } from '../Course';
+import { SCCourseTemplateType } from '../../types/course';
+const classes = {
+    root: `${PREFIX}-root`,
+    title: `${PREFIX}-title`,
+    noResults: `${PREFIX}-no-results`,
+    showMore: `${PREFIX}-show-more`,
+    dialogRoot: `${PREFIX}-dialog-root`,
+    endMessage: `${PREFIX}-end-message`
+};
+const Root = styled(Widget, {
+    name: PREFIX,
+    slot: 'Root'
+})(() => ({}));
+const DialogRoot = styled(BaseDialog, {
+    name: PREFIX,
+    slot: 'DialogRoot'
+})(() => ({}));
+/**
+ * > API documentation for the Community-JS User Profile Courses Created Widget component. Learn about the available props and the CSS API.
+ *
+ *
+ * This component renders the list of the courses that the given user follows.
+ * Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-ui/Components/UserCreatedCourses)
+
+ #### Import
+ ```jsx
+ import {UserCreatedCoursesWidget} from '@selfcommunity/react-ui';
+ ```
+ #### Component Name
+ The name `SCUserCreatedCoursesWidget` can be used when providing style overrides in the theme.
+
+ #### CSS
+
+ |Rule Name|Global class|Description|
+ |---|---|---|
+ |root|.SCUserCreatedCoursesWidget-root|Styles applied to the root element.|
+ |title|.SCUserCreatedCoursesWidget-title|Styles applied to the title element.|
+ |noResults|.SCUserCreatedCoursesWidget-no-results|Styles applied to no results section.|
+ |showMore|.SCUserCreatedCoursesWidget-show-more|Styles applied to show more button element.|
+ |dialogRoot|.SCUserCreatedCoursesWidget-dialog-root|Styles applied to the root dialog element.|
+ |endMessage|.SCUserCreatedCoursesWidget-end-message|Styles applied to the end message element.|
+ * @param inProps
+ */
+export default function UserCreatedCoursesWidget(inProps) {
+    // PROPS
+    const props = useThemeProps({
+        props: inProps,
+        name: PREFIX
+    });
+    const { userId, limit = 3, className, CourseProps = {}, cacheStrategy = CacheStrategies.NETWORK_ONLY, onHeightChange, onStateChange, DialogProps = {} } = props, rest = __rest(props, ["userId", "limit", "className", "CourseProps", "cacheStrategy", "onHeightChange", "onStateChange", "DialogProps"]);
+    // CONTEXT
+    const scUserContext = useSCUser();
+    const { preferences, features } = useSCPreferences();
+    const coursesEnabled = useMemo(() => preferences &&
+        features &&
+        features.includes(SCFeatureName.COURSE) &&
+        SCPreferences.CONFIGURATIONS_COURSES_ENABLED in preferences &&
+        preferences[SCPreferences.CONFIGURATIONS_COURSES_ENABLED].value, [preferences, features]);
+    // STATE
+    const [state, dispatch] = useReducer(dataWidgetReducer, {
+        isLoadingNext: false,
+        next: null,
+        cacheKey: SCCache.getWidgetStateCacheKey(SCCache.USER_CREATED_COURSES_STATE_CACHE_PREFIX_KEY, userId),
+        cacheStrategy
+    }, stateWidgetInitializer);
+    const [openDialog, setOpenDialog] = useState(false);
+    /**
+     * Initialize component
+     * Fetch data only if the component is not initialized, and it is not loading data
+     */
+    const _initComponent = useMemo(() => () => {
+        if (!state.initialized && !state.isLoadingNext) {
+            CourseService.getUserJoinedCourses(userId, { statuses: SCCourseJoinStatusType.CREATOR })
+                .then((courses) => {
+                dispatch({
+                    type: actionWidgetTypes.LOAD_NEXT_SUCCESS,
+                    payload: {
+                        count: courses.count,
+                        results: courses.results,
+                        initialized: true
+                    }
+                });
+            })
+                .catch((error) => {
+                dispatch({ type: actionWidgetTypes.LOAD_NEXT_FAILURE, payload: { errorLoadNext: error } });
+                Logger.error(SCOPE_SC_UI, error);
+            });
+        }
+    }, [state.isLoadingNext, state.initialized, userId, dispatch]);
+    // EFFECTS
+    useEffect(() => {
+        let _t;
+        if (coursesEnabled && isInteger(userId) && scUserContext.user !== undefined) {
+            _t = setTimeout(_initComponent);
+            return () => {
+                _t && clearTimeout(_t);
+            };
+        }
+    }, [scUserContext.user, coursesEnabled, userId]);
+    /**
+     * Virtual feed update
+     */
+    useEffect(() => {
+        onHeightChange && onHeightChange();
+    }, [state.results.length]);
+    useEffect(() => {
+        if (!coursesEnabled && !scUserContext.user && !isInteger(userId)) {
+            return;
+        }
+        else if (cacheStrategy === CacheStrategies.NETWORK_ONLY) {
+            onStateChange && onStateChange({ cacheStrategy: CacheStrategies.CACHE_FIRST });
+        }
+    }, [coursesEnabled, cacheStrategy, scUserContext.user, userId]);
+    // HANDLERS
+    const handleToggleDialogOpen = () => {
+        setOpenDialog((prev) => !prev);
+    };
+    // RENDER
+    if (!coursesEnabled || (!state.count && state.initialized) || !userId) {
+        return _jsx(HiddenPlaceholder, {});
+    }
+    if (!state.initialized) {
+        return _jsx(Skeleton, {});
+    }
+    const content = (_jsxs(CardContent, { children: [_jsx(Typography, Object.assign({ className: classes.title, variant: "h5" }, { children: _jsx(FormattedMessage, { id: "ui.userCreatedCoursesWidget.title", defaultMessage: "ui.userCreatedCoursesWidget.title", values: {
+                        total: state.count
+                    } }) })), !state.count ? (_jsx(Typography, Object.assign({ className: classes.noResults, variant: "body2" }, { children: _jsx(FormattedMessage, { id: "ui.userCreatedCoursesWidget.subtitle.noResults", defaultMessage: "ui.userCreatedCoursesWidget.subtitle.noResults" }) }))) : (_jsxs(React.Fragment, { children: [_jsx(List, { children: state.results.slice(0, limit).map((course) => (_jsx(ListItem, { children: _jsx(Course, Object.assign({ elevation: 0, template: SCCourseTemplateType.SNIPPET, course: course, userProfileSnippet: true }, CourseProps)) }, course.id))) }), limit < state.count && (_jsx(Button, Object.assign({ className: classes.showMore, onClick: handleToggleDialogOpen }, { children: _jsx(FormattedMessage, { id: "ui.userCreatedCoursesWidget.button.showAll", defaultMessage: "ui.userCreatedCoursesWidget.button.showAll" }) }))), openDialog && (_jsxs(DialogRoot, Object.assign({ className: classes.dialogRoot, title: _jsx(FormattedMessage, { id: "ui.userCreatedCoursesWidget.title", defaultMessage: "ui.userCreatedCoursesWidget.title", values: { total: state.count } }), onClose: handleToggleDialogOpen, open: openDialog, scroll: "paper" }, DialogProps, { children: [_jsxs(List, { children: [state.results.map((c) => (_jsx(ListItem, { children: _jsx(Course, Object.assign({ elevation: 0, template: SCCourseTemplateType.SNIPPET, course: c, userProfileSnippet: true }, CourseProps)) }, c.id))), state.isLoadingNext && (_jsx(ListItem, { children: _jsx(CourseSkeleton, { template: SCCourseTemplateType.SNIPPET, elevation: 0, CourseProps: { userProfileSnippet: true } }) }))] }), _jsx(Typography, Object.assign({ className: classes.endMessage }, { children: _jsx(FormattedMessage, { id: "ui.userCreatedCoursesWidget.noMoreResults", defaultMessage: "ui.userCreatedCoursesWidget.noMoreResults" }) }))] })))] }))] }));
+    return (_jsx(Root, Object.assign({ className: classNames(classes.root, className) }, rest, { children: content })));
+}

package/lib/esm/components/UserCreatedCoursesWidget/constants.d.ts

@@ -0,0 +1 @@
+export declare const PREFIX = "SCUserCreatedCoursesWidget";

package/lib/esm/components/UserCreatedCoursesWidget/constants.js

@@ -0,0 +1 @@
+export const PREFIX = 'SCUserCreatedCoursesWidget';

package/lib/esm/components/UserCreatedCoursesWidget/index.d.ts

@@ -0,0 +1,4 @@
+import UserCreatedCoursesWidget, { UserCreatedCoursesWidgetProps } from './UserCreatedCoursesWidget';
+import UserCreatedCoursesWidgetSkeleton from './Skeleton';
+export default UserCreatedCoursesWidget;
+export { UserCreatedCoursesWidgetSkeleton, UserCreatedCoursesWidgetProps };

package/lib/esm/components/UserCreatedCoursesWidget/index.js

@@ -0,0 +1,4 @@
+import UserCreatedCoursesWidget from './UserCreatedCoursesWidget';
+import UserCreatedCoursesWidgetSkeleton from './Skeleton';
+export default UserCreatedCoursesWidget;
+export { UserCreatedCoursesWidgetSkeleton };

package/lib/esm/components/UserFollowedCategoriesWidget/Skeleton.js

@@ -1,6 +1,6 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import CategoriesSuggestionWidgetSkeleton from '../CategoriesSuggestionWidget/Skeleton';
-import { styled } from '@mui/material/styles';
+import { styled } from '@mui/material';
 const PREFIX = 'SCUserFollowedCategoriesWidgetSkeleton';
 const classes = {
     root: `${PREFIX}-skeleton-root`

package/lib/esm/components/UserFollowedCategoriesWidget/UserFollowedCategoriesWidget.js

@@ -1,12 +1,10 @@
 import { __rest } from "tslib";
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-import React, { useContext, useEffect, useMemo, useReducer, useState } from 'react';
-import { styled } from '@mui/material/styles';
-import List from '@mui/material/List';
-import { Button, CardContent, ListItem, Typography } from '@mui/material';
+import React, { useEffect, useMemo, useReducer, useState } from 'react';
+import { Button, CardContent, ListItem, Typography, styled, List } from '@mui/material';
 import { UserService } from '@selfcommunity/api-services';
 import { CacheStrategies, isInteger, Logger } from '@selfcommunity/utils';
-import { SCCache, SCPreferences, SCPreferencesContext, useSCUser } from '@selfcommunity/react-core';
+import { SCCache, SCPreferences, useSCPreferences, useSCUser } from '@selfcommunity/react-core';
 import { actionWidgetTypes, dataWidgetReducer, stateWidgetInitializer } from '../../utils/widget';
 import Category, { CategorySkeleton } from '../Category';
 import { SCOPE_SC_UI } from '../../constants/Errors';
@@ -70,9 +68,9 @@ export default function UserFollowedCategoriesWidget(inProps) {
     // CONTEXT
     const scUserContext = useSCUser();
     const isMe = useMemo(() => scUserContext.user && userId === scUserContext.user.id, [scUserContext.user, userId]);
-    const scPreferencesContext = useContext(SCPreferencesContext);
-    const contentAvailability = useMemo(() => SCPreferences.CONFIGURATIONS_CONTENT_AVAILABILITY in scPreferencesContext.preferences &&
-        scPreferencesContext.preferences[SCPreferences.CONFIGURATIONS_CONTENT_AVAILABILITY].value, [scPreferencesContext]);
+    const { preferences } = useSCPreferences();
+    const contentAvailability = useMemo(() => SCPreferences.CONFIGURATIONS_CONTENT_AVAILABILITY in preferences && preferences[SCPreferences.CONFIGURATIONS_CONTENT_AVAILABILITY].value, [preferences]);
+    const categoryFollowEnabled = useMemo(() => SCPreferences.CONFIGURATIONS_CATEGORY_FOLLOW_ENABLED in preferences && preferences[SCPreferences.CONFIGURATIONS_CATEGORY_FOLLOW_ENABLED].value, [preferences]);
     // STATE
     const [state, dispatch] = useReducer(dataWidgetReducer, {
         isLoadingNext: false,
@@ -108,13 +106,16 @@ export default function UserFollowedCategoriesWidget(inProps) {
     useEffect(() => {
         var _a;
         let _t;
-        if ((contentAvailability || (!contentAvailability && ((_a = scUserContext.user) === null || _a === void 0 ? void 0 : _a.id))) && isInteger(userId) && scUserContext.user !== undefined) {
+        if ((contentAvailability || (!contentAvailability && ((_a = scUserContext.user) === null || _a === void 0 ? void 0 : _a.id))) &&
+            isInteger(userId) &&
+            scUserContext.user !== undefined &&
+            categoryFollowEnabled) {
             _t = setTimeout(_initComponent);
             return () => {
                 _t && clearTimeout(_t);
             };
         }
-    }, [scUserContext.user, contentAvailability, userId]);
+    }, [scUserContext.user, contentAvailability, userId, categoryFollowEnabled]);
     /**
      * Virtual feed update
      */
@@ -151,7 +152,7 @@ export default function UserFollowedCategoriesWidget(inProps) {
         setOpenDialog((prev) => !prev);
     };
     // RENDER
-    if ((autoHide && !state.count && state.initialized) || !userId) {
+    if ((autoHide && !state.count && state.initialized) || !userId || !categoryFollowEnabled) {
         return _jsx(HiddenPlaceholder, {});
     }
     if (!state.initialized) {

package/lib/esm/components/UserFollowedUsersWidget/Skeleton.js

@@ -1,6 +1,6 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { CategoryTrendingPeopleWidgetSkeleton } from '../CategoryTrendingUsersWidget';
-import { styled } from '@mui/material/styles';
+import { styled } from '@mui/material';
 import { PREFIX } from './constants';
 const classes = {
     root: `${PREFIX}-skeleton-root`

package/lib/esm/components/UserFollowedUsersWidget/UserFollowedUsersWidget.js

@@ -1,9 +1,7 @@
 import { __rest } from "tslib";
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import React, { useEffect, useMemo, useReducer, useState } from 'react';
-import { styled } from '@mui/material/styles';
-import List from '@mui/material/List';
-import { Button, CardContent, ListItem, Typography, useMediaQuery, useTheme } from '@mui/material';
+import { Button, CardContent, ListItem, Typography, useMediaQuery, useTheme, styled, List } from '@mui/material';
 import Widget from '../Widget';
 import { http, Endpoints, UserService } from '@selfcommunity/api-services';
 import { CacheStrategies, isInteger, Logger } from '@selfcommunity/utils';

package/lib/esm/components/UserFollowersWidget/Skeleton.js

@@ -1,6 +1,6 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { CategoryTrendingPeopleWidgetSkeleton } from '../CategoryTrendingUsersWidget';
-import { styled } from '@mui/material/styles';
+import { styled } from '@mui/material';
 import { PREFIX } from './constants';
 const classes = {
     root: `${PREFIX}-skeleton-root`

package/lib/esm/components/UserFollowersWidget/UserFollowersWidget.js

@@ -1,9 +1,7 @@
 import { __rest } from "tslib";
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import React, { useEffect, useMemo, useReducer, useState } from 'react';
-import { styled } from '@mui/material/styles';
-import List from '@mui/material/List';
-import { Button, CardContent, ListItem, Typography, useMediaQuery, useTheme } from '@mui/material';
+import { Button, CardContent, ListItem, Typography, useMediaQuery, useTheme, styled, List } from '@mui/material';
 import Widget from '../Widget';
 import { http, Endpoints, UserService } from '@selfcommunity/api-services';
 import { CacheStrategies, isInteger, Logger } from '@selfcommunity/utils';

package/lib/esm/components/UserInfo/Skeleton.js

@@ -1,7 +1,5 @@
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-import { Box, Typography } from '@mui/material';
-import { styled } from '@mui/material/styles';
-import Skeleton from '@mui/material/Skeleton';
+import { Box, Typography, styled, Skeleton } from '@mui/material';
 import { PREFIX } from './constants';
 const classes = {
     root: `${PREFIX}-skeleton-root`,

package/lib/esm/components/UserInfo/UserInfo.js

@@ -1,8 +1,7 @@
 import { __rest } from "tslib";
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import { useMemo } from 'react';
-import { styled } from '@mui/material/styles';
-import { Box, Typography } from '@mui/material';
+import { Box, Typography, styled } from '@mui/material';
 import { defineMessages, useIntl } from 'react-intl';
 import { camelCase, Logger } from '@selfcommunity/utils';
 import { SCPreferences, useSCFetchUser, useSCPreferences } from '@selfcommunity/react-core';

package/lib/esm/components/UserPaymentMethods/Skeleton.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+export interface UserPaymentMethodsSkeletonProps {
+    /**
+     * Overrides or extends the styles applied to the component.
+     * @default null
+     */
+    className?: string;
+    /**
+     * Show billing address
+     */
+    showBillingAddress?: boolean;
+}
+export declare type UserPaymentMethodsSkeletonRef = {};
+declare const _default: React.ForwardRefExoticComponent<UserPaymentMethodsSkeletonProps & React.RefAttributes<UserPaymentMethodsSkeletonRef>>;
+export default _default;

package/lib/esm/components/UserPaymentMethods/Skeleton.js

@@ -0,0 +1,47 @@
+import { __rest } from "tslib";
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { forwardRef } from 'react';
+import { Box, TableCell, TableRow, Skeleton, styled } from '@mui/material';
+import { PREFIX } from './constants';
+import { useThemeProps } from '@mui/system';
+import classNames from 'classnames';
+const classes = {
+    root: `${PREFIX}-skeleton-root`,
+    field: `${PREFIX}-field`
+};
+const Root = styled(Box, {
+    name: PREFIX,
+    slot: 'SkeletonRoot'
+})(() => ({}));
+/**
+ * > API documentation for the Community-JS User Payment Methods Skeleton component. Learn about the available props and the CSS API.
+
+ #### Import
+
+ ```jsx
+ import {UserPaymentMethodsSkeleton} from '@selfcommunity/react-ui';
+ ```
+
+ #### Component Name
+
+ The name `SCUserPaymentMethodsSkeleton-skeleton-root` can be used when providing style overrides in the theme.
+
+ #### CSS
+
+ |Rule Name|Global class|Description|
+ |---|---|---|
+ |root|.SCUserPaymentMethodsSkeleton-skeleton-root|Styles applied to the root element.|
+ *
+ * @param inProps
+ * @param ref
+ */
+const UserPaymentMethodsSkeleton = (inProps, ref) => {
+    // PROPS
+    const props = useThemeProps({
+        props: inProps,
+        name: PREFIX
+    });
+    const { className = null, showBillingAddress = false } = props, rest = __rest(props, ["className", "showBillingAddress"]);
+    return (_jsx(Root, Object.assign({ className: classNames(classes.root, className) }, rest, { children: _jsxs(TableRow, { children: [_jsx(TableCell, Object.assign({ component: "th", scope: "row" }, { children: _jsx(Skeleton, { variant: "text", height: 40 }) })), _jsx(TableCell, Object.assign({ component: "th", scope: "row" }, { children: _jsx(Skeleton, { variant: "text", height: 40, width: 200 }) })), _jsx(TableCell, Object.assign({ component: "th", scope: "row" }, { children: _jsx(Skeleton, { variant: "text", height: 40, width: 50 }) })), showBillingAddress && (_jsx(TableCell, Object.assign({ component: "th", scope: "row" }, { children: _jsx(Skeleton, { variant: "text", height: 40, width: 150 }) }))), _jsx(TableCell, Object.assign({ component: "th", scope: "row" }, { children: _jsx(Skeleton, { variant: "rectangular", width: 25, height: 25 }) })), _jsx(TableCell, Object.assign({ component: "th", scope: "row" }, { children: _jsx(Skeleton, { variant: "rounded", width: 105, height: 35 }) }))] }) })));
+};
+export default forwardRef(UserPaymentMethodsSkeleton);

package/lib/esm/components/UserPaymentMethods/UserPaymentMethods.d.ts

@@ -0,0 +1,19 @@
+import React from 'react';
+export interface UserPaymentMethodsProps {
+    /**
+     * Overrides or extends the styles applied to the component.
+     * @default null
+     */
+    className?: string;
+    /**
+     * Show billing address
+     */
+    showBillingAddress?: boolean;
+    /**
+     * Any other properties
+     */
+    [p: string]: any;
+}
+export declare type UserPaymentMethodsRef = {};
+declare const _default: React.ForwardRefExoticComponent<Pick<UserPaymentMethodsProps, keyof UserPaymentMethodsProps> & React.RefAttributes<UserPaymentMethodsRef>>;
+export default _default;