@selfcommunity/react-ui 0.7.9-alpha.1 → 0.7.9-alpha.3

package/lib/esm/components/GroupRequestsWidget/GroupRequestsWidget.js

@@ -0,0 +1,191 @@
+import { __rest } from "tslib";
+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 Widget from '../Widget';
+import { http, Endpoints, GroupService } from '@selfcommunity/api-services';
+import { CacheStrategies, isInteger, Logger } from '@selfcommunity/utils';
+import { SCCache, SCPreferences, useSCFetchGroup, useSCPreferences, useSCUser } from '@selfcommunity/react-core';
+import { actionWidgetTypes, dataWidgetReducer, stateWidgetInitializer } from '../../utils/widget';
+import Skeleton from './Skeleton';
+import { FormattedMessage } from 'react-intl';
+import classNames from 'classnames';
+import { SCOPE_SC_UI } from '../../constants/Errors';
+import BaseDialog from '../../shared/BaseDialog';
+import InfiniteScroll from '../../shared/InfiniteScroll';
+import { useThemeProps } from '@mui/system';
+import HiddenPlaceholder from '../../shared/HiddenPlaceholder';
+import { PREFIX } from './constants';
+import User, { UserSkeleton } from '../User';
+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 Group Requests Widget component. Learn about the available props and the CSS API.
+ *
+ *
+ * This component renders the list of the follows of the given group.
+ * Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-ui/Components/GroupRequests)
+
+ #### Import
+
+ ```jsx
+ import {GroupRequestsWidget} from '@selfcommunity/react-ui';
+ ```
+
+ #### Component Name
+
+ The name `SCGroupRequestsWidget` can be used when providing style overrides in the theme.
+
+
+ #### CSS
+
+ |Rule Name|Global class|Description|
+ |---|---|---|
+ |root|.SCGroupRequestsWidget-root|Styles applied to the root element.|
+ |title|.SCGroupRequestsWidget-title|Styles applied to the title element.|
+ |noResults|.SCGroupRequestsWidget-no-results|Styles applied to no results section.|
+ |showMore|.SCGroupRequestsWidget-show-more|Styles applied to show more button element.|
+ |dialogRoot|.SCGroupRequestsWidget-dialog-root|Styles applied to the dialog root element.|
+ |endMessage|.SCGroupRequestsWidget-end-message|Styles applied to the end message element.|
+
+ * @param inProps
+ */
+export default function GroupRequestsWidget(inProps) {
+    // PROPS
+    const props = useThemeProps({
+        props: inProps,
+        name: PREFIX
+    });
+    const { groupId, group, autoHide = false, limit = 5, className, cacheStrategy = CacheStrategies.NETWORK_ONLY, onHeightChange, onStateChange, UserProps = {}, DialogProps = {} } = props, rest = __rest(props, ["groupId", "group", "autoHide", "limit", "className", "cacheStrategy", "onHeightChange", "onStateChange", "UserProps", "DialogProps"]);
+    // STATE
+    const [state, dispatch] = useReducer(dataWidgetReducer, {
+        isLoadingNext: false,
+        next: null,
+        cacheKey: SCCache.getWidgetStateCacheKey(SCCache.GROUP_REQUESTS_TOOLS_STATE_CACHE_PREFIX_KEY, isInteger(groupId) ? groupId : group.id),
+        cacheStrategy,
+        visibleItems: limit
+    }, stateWidgetInitializer);
+    const [openDialog, setOpenDialog] = useState(false);
+    // CONTEXT
+    const scUserContext = useSCUser();
+    const scPreferencesContext = useSCPreferences();
+    const { scGroup } = useSCFetchGroup({ id: groupId, group });
+    // MEMO
+    const contentAvailability = useMemo(() => SCPreferences.CONFIGURATIONS_CONTENT_AVAILABILITY in scPreferencesContext.preferences &&
+        scPreferencesContext.preferences[SCPreferences.CONFIGURATIONS_CONTENT_AVAILABILITY].value, [scPreferencesContext.preferences]);
+    // HOOKS
+    const theme = useTheme();
+    const isMobile = useMediaQuery(theme.breakpoints.down('md'));
+    /**
+     * 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) {
+            dispatch({ type: actionWidgetTypes.LOADING_NEXT });
+            GroupService.getGroupWaitingApprovalSubscribers(scGroup.id, { limit })
+                .then((payload) => {
+                dispatch({ type: actionWidgetTypes.LOAD_NEXT_SUCCESS, payload: Object.assign(Object.assign({}, payload), { initialized: true }) });
+            })
+                .catch((error) => {
+                dispatch({ type: actionWidgetTypes.LOAD_NEXT_FAILURE, payload: { errorLoadNext: error } });
+                Logger.error(SCOPE_SC_UI, error);
+            });
+        }
+    }, [state.isLoadingNext, state.initialized, scGroup, limit, dispatch]);
+    // EFFECTS
+    useEffect(() => {
+        var _a;
+        let _t;
+        if ((contentAvailability || (!contentAvailability && ((_a = scUserContext.user) === null || _a === void 0 ? void 0 : _a.id))) && scGroup && scUserContext.user !== undefined) {
+            _t = setTimeout(_initComponent);
+            return () => {
+                _t && clearTimeout(_t);
+            };
+        }
+    }, [scUserContext.user, contentAvailability, scGroup]);
+    useEffect(() => {
+        if (openDialog && state.next && state.results.length === limit && state.initialized) {
+            dispatch({ type: actionWidgetTypes.LOADING_NEXT });
+            GroupService.getGroupWaitingApprovalSubscribers(scGroup.id, { offset: limit, limit: 10 })
+                .then((payload) => {
+                dispatch({ type: actionWidgetTypes.LOAD_NEXT_SUCCESS, payload: payload });
+            })
+                .catch((error) => {
+                dispatch({ type: actionWidgetTypes.LOAD_NEXT_FAILURE, payload: { errorLoadNext: error } });
+                Logger.error(SCOPE_SC_UI, error);
+            });
+        }
+    }, [openDialog, state.next, state.results.length, state.initialized, limit]);
+    /**
+     * Virtual feed update
+     */
+    useEffect(() => {
+        onHeightChange && onHeightChange();
+    }, [state.results]);
+    useEffect(() => {
+        if (!scGroup || (!contentAvailability && !scUserContext.user)) {
+            return;
+        }
+        else if (cacheStrategy === CacheStrategies.NETWORK_ONLY) {
+            onStateChange && onStateChange({ cacheStrategy: CacheStrategies.CACHE_FIRST });
+        }
+    }, [scUserContext.user, scGroup, contentAvailability]);
+    useEffect(() => {
+        if (!scGroup || !scUserContext.user || !state.initialized) {
+            return;
+        }
+    }, []);
+    // HANDLERS
+    const handleNext = useMemo(() => () => {
+        dispatch({ type: actionWidgetTypes.LOADING_NEXT });
+        http
+            .request({
+            url: state.next,
+            method: Endpoints.GetGroupWaitingApprovalSubscribers.method
+        })
+            .then((res) => {
+            dispatch({ type: actionWidgetTypes.LOAD_NEXT_SUCCESS, payload: res.data });
+        });
+    }, [dispatch, state.next, state.isLoadingNext, state.initialized]);
+    const handleToggleDialogOpen = () => {
+        setOpenDialog((prev) => !prev);
+    };
+    // RENDER
+    if ((autoHide && !state.count && state.initialized) || (!contentAvailability && !scUserContext.user) || !scGroup) {
+        return React.createElement(HiddenPlaceholder, null);
+    }
+    if (!state.initialized) {
+        return React.createElement(Skeleton, null);
+    }
+    const content = (React.createElement(CardContent, null,
+        React.createElement(Typography, { className: classes.title, variant: "h5" },
+            React.createElement(FormattedMessage, { id: "ui.groupRequestsWidget.title", defaultMessage: "ui.groupRequestsWidget.title" })),
+        !state.count ? (React.createElement(Typography, { className: classes.noResults, variant: "body2" },
+            React.createElement(FormattedMessage, { id: "ui.groupRequestsWidget.subtitle.noResults", defaultMessage: "" }))) : (React.createElement(React.Fragment, null,
+            React.createElement(List, null, state.results.slice(0, state.visibleItems).map((user) => (React.createElement(ListItem, { key: user.id },
+                React.createElement(User, { elevation: 0, actions: React.createElement(React.Fragment, null), user: user, userId: user.id, buttonProps: { onClick: () => console.log(user) } }))))),
+            state.count > state.visibleItems && (React.createElement(Button, { className: classes.showMore, onClick: handleToggleDialogOpen },
+                React.createElement(FormattedMessage, { id: "ui.groupRequestsWidget.button.showMore", defaultMessage: "ui.groupRequestsWidget.button.showMore" }))))),
+        openDialog && (React.createElement(DialogRoot, Object.assign({ className: classes.dialogRoot, title: React.createElement(FormattedMessage, { defaultMessage: "ui.groupRequestsWidget.dialogTitle", id: "ui.groupRequestsWidget.dialogTitle", values: { total: scGroup.subscribers_counter } }), onClose: handleToggleDialogOpen, open: openDialog }, DialogProps),
+            React.createElement(InfiniteScroll, { dataLength: state.results.length, next: handleNext, hasMoreNext: Boolean(state.next), loaderNext: React.createElement(UserSkeleton, Object.assign({ elevation: 0 }, UserProps)), height: isMobile ? '100%' : 400, endMessage: React.createElement(Typography, { className: classes.endMessage },
+                    React.createElement(FormattedMessage, { id: "ui.groupRequestsWidget.noMoreResults", defaultMessage: "ui.groupRequestsWidget.noMoreResults" })) },
+                React.createElement(List, null, state.results.map((user) => (React.createElement(ListItem, { key: user.id },
+                    React.createElement(User, { elevation: 0, actions: React.createElement(React.Fragment, null), user: user, userId: user.id, buttonProps: { onClick: () => console.log(user) } }))))))))));
+    return (React.createElement(Root, Object.assign({ className: classNames(classes.root, className) }, rest), content));
+}

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

@@ -0,0 +1,22 @@
+import { WidgetProps } from '../Widget';
+/**
+ * > API documentation for the Community-JS Group Requests Widget Skeleton component. Learn about the available props and the CSS API.
+
+ #### Import
+
+ ```jsx
+ import {GroupRequestsWidgetSkeleton} from '@selfcommunity/react-ui';
+ ```
+
+ #### Component Name
+
+ The name `SCGroupRequestsWidget-skeleton-root` can be used when providing style overrides in the theme.
+
+ #### CSS
+
+ |Rule Name|Global class|Description|
+ |---|---|---|
+ |root|.SCGroupRequestsWidget-skeleton-root|Styles applied to the root element.|
+ *
+ */
+export default function GroupRequestsWidgetSkeleton(props: WidgetProps): JSX.Element;

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

@@ -0,0 +1,34 @@
+import React from 'react';
+import { CategoryTrendingPeopleWidgetSkeleton } from '../CategoryTrendingUsersWidget';
+import { styled } from '@mui/material/styles';
+import { PREFIX } from './constants';
+const classes = {
+    root: `${PREFIX}-skeleton-root`
+};
+const Root = styled(CategoryTrendingPeopleWidgetSkeleton, {
+    name: PREFIX,
+    slot: 'SkeletonRoot'
+})(() => ({}));
+/**
+ * > API documentation for the Community-JS Group Requests Widget Skeleton component. Learn about the available props and the CSS API.
+
+ #### Import
+
+ ```jsx
+ import {GroupRequestsWidgetSkeleton} from '@selfcommunity/react-ui';
+ ```
+
+ #### Component Name
+
+ The name `SCGroupRequestsWidget-skeleton-root` can be used when providing style overrides in the theme.
+
+ #### CSS
+
+ |Rule Name|Global class|Description|
+ |---|---|---|
+ |root|.SCGroupRequestsWidget-skeleton-root|Styles applied to the root element.|
+ *
+ */
+export default function GroupRequestsWidgetSkeleton(props) {
+    return React.createElement(Root, Object.assign({ className: classes.root }, props));
+}

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

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

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

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

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

@@ -0,0 +1,4 @@
+import GroupRequestsWidget, { GroupRequestsWidgetProps } from './GroupRequestsWidget';
+import GroupRequestsWidgetSkeleton from './Skeleton';
+export default GroupRequestsWidget;
+export { GroupRequestsWidgetProps, GroupRequestsWidgetSkeleton };

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

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

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

@@ -0,0 +1,51 @@
+import { SCGroupType } from '@selfcommunity/types';
+export interface GroupSubscribeButtonProps {
+    /**
+     * Overrides or extends the styles applied to the component.
+     * @default null
+     */
+    className?: string;
+    /**
+     * Group Object
+     * @default null
+     */
+    group?: SCGroupType;
+    /**
+     * Id of the group
+     * @default null
+     */
+    groupId?: number;
+    /**
+     * onJoin callback
+     * @param user
+     * @param joined
+     */
+    onJoin?: (group: SCGroupType, member: boolean) => any;
+    /**
+     * Others properties
+     */
+    [p: string]: any;
+}
+/**
+ * > API documentation for the Community-JS Group Subscribe Button component. Learn about the available props and the CSS API.
+
+ #### Import
+
+ ```jsx
+ import {GroupSubscribeButton} from '@selfcommunity/react-ui';
+ ```
+
+ #### Component Name
+
+ The name `SCGroupSubscribeButton` can be used when providing style overrides in the theme.
+
+
+ #### CSS
+
+ |Rule Name|Global class|Description|
+ |---|---|---|
+ |root|.SCGroupSubscribeButton-root|Styles applied to the root element.|
+
+ * @param inProps
+ */
+export default function GroupSubscribeButton(inProps: GroupSubscribeButtonProps): JSX.Element;

package/lib/esm/components/GroupSubscribeButton/GroupSubscribeButton.js

@@ -0,0 +1,114 @@
+import { __rest } from "tslib";
+import React, { useEffect, useState } from 'react';
+import { styled } from '@mui/material/styles';
+import { CacheStrategies, Logger } from '@selfcommunity/utils';
+import { useSCContext, useSCFetchGroup, useSCUser } from '@selfcommunity/react-core';
+import { SCGroupPrivacyType, SCGroupSubscriptionStatusType } from '@selfcommunity/types';
+import { LoadingButton } from '@mui/lab';
+import { FormattedMessage } from 'react-intl';
+import classNames from 'classnames';
+import { useThemeProps } from '@mui/system';
+import { SCOPE_SC_UI } from '../../constants/Errors';
+const PREFIX = 'SCGroupSubscribeButton';
+const classes = {
+    root: `${PREFIX}-root`
+};
+const Root = styled(LoadingButton, {
+    name: PREFIX,
+    slot: 'Root',
+    overridesResolver: (props, styles) => styles.root
+})(({ theme }) => ({}));
+/**
+ * > API documentation for the Community-JS Group Subscribe Button component. Learn about the available props and the CSS API.
+
+ #### Import
+
+ ```jsx
+ import {GroupSubscribeButton} from '@selfcommunity/react-ui';
+ ```
+
+ #### Component Name
+
+ The name `SCGroupSubscribeButton` can be used when providing style overrides in the theme.
+
+
+ #### CSS
+
+ |Rule Name|Global class|Description|
+ |---|---|---|
+ |root|.SCGroupSubscribeButton-root|Styles applied to the root element.|
+
+ * @param inProps
+ */
+export default function GroupSubscribeButton(inProps) {
+    // PROPS
+    const props = useThemeProps({
+        props: inProps,
+        name: PREFIX
+    });
+    const { className, groupId, group, onJoin } = props, rest = __rest(props, ["className", "groupId", "group", "onJoin"]);
+    // STATE
+    const [status, setStatus] = useState(null);
+    // CONTEXT
+    const scContext = useSCContext();
+    const scUserContext = useSCUser();
+    const scGroupsManager = scUserContext.managers.groups;
+    // CONST
+    const authUserId = scUserContext.user ? scUserContext.user.id : null;
+    const { scGroup } = useSCFetchGroup({
+        id: groupId,
+        group,
+        cacheStrategy: authUserId ? CacheStrategies.CACHE_FIRST : CacheStrategies.STALE_WHILE_REVALIDATE
+    });
+    useEffect(() => {
+        /**
+         * Call scGroupsManager.subscriptionStatus inside an effect
+         * to avoid warning rendering child during update parent state
+         */
+        if (authUserId) {
+            setStatus(scGroupsManager.subscriptionStatus(scGroup));
+        }
+    }, [authUserId, scGroupsManager.subscriptionStatus]);
+    const subscribe = () => {
+        scGroupsManager
+            .subscribe(scGroup)
+            .then(() => {
+            // onJoin && onJoin(scGroup, !joined);
+        })
+            .catch((e) => {
+            Logger.error(SCOPE_SC_UI, e);
+        });
+    };
+    const handleSubscribeAction = () => {
+        if (!scUserContext.user) {
+            scContext.settings.handleAnonymousAction();
+        }
+        else {
+            subscribe();
+        }
+    };
+    /**
+     * Get current translated status
+     */
+    const getStatus = () => {
+        let _status;
+        switch (status) {
+            case SCGroupSubscriptionStatusType.REQUESTED:
+                _status = React.createElement(FormattedMessage, { defaultMessage: "ui.groupJoinButton.waitingApproval", id: "ui.groupJoinButton.waitingApproval" });
+                break;
+            case SCGroupSubscriptionStatusType.SUBSCRIBED:
+                _status = React.createElement(FormattedMessage, { defaultMessage: "ui.groupSubscribeButton.exit", id: "ui.groupSubscribeButton.exit" });
+                break;
+            default:
+                scGroup.privacy === SCGroupPrivacyType.PUBLIC
+                    ? (_status = React.createElement(FormattedMessage, { defaultMessage: "ui.groupSubscribeButton.enter", id: "ui.groupSubscribeButton.enter" }))
+                    : (_status = React.createElement(FormattedMessage, { defaultMessage: "ui.groupJoinButton.requestAccess", id: "ui.groupJoinButton.requestAccess" }));
+                break;
+        }
+        return _status;
+    };
+    if (!scGroup || (scGroup && !scGroup.subscription_status)) {
+        return null;
+    }
+    return (React.createElement(Root, Object.assign({ size: "small", variant: "outlined", onClick: handleSubscribeAction, loading: scUserContext.user ? scGroupsManager.isLoading(scGroup) : null, className: classNames(classes.root, className) }, rest), getStatus()));
+}

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

@@ -0,0 +1,3 @@
+import GroupSubscribeButton, { GroupSubscribeButtonProps } from './GroupSubscribeButton';
+export default GroupSubscribeButton;
+export { GroupSubscribeButtonProps };

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

@@ -0,0 +1,2 @@
+import GroupSubscribeButton from './GroupSubscribeButton';
+export default GroupSubscribeButton;

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

@@ -0,0 +1,65 @@
+import { EndpointType } from '@selfcommunity/api-services';
+import { CacheStrategies } from '@selfcommunity/utils';
+import { GroupProps } from '../Group';
+export interface GroupsProps {
+    /**
+     * Endpoint to call
+     */
+    endpoint: EndpointType;
+    /**
+     * Hides this component
+     * @default false
+     */
+    autoHide?: boolean;
+    /**
+     * Limit the number of users to show
+     * @default false
+     */
+    limit?: number;
+    /**
+     * Caching strategies
+     * @default CacheStrategies.CACHE_FIRST
+     */
+    cacheStrategy?: CacheStrategies;
+    /**
+     * Props to spread to single user object
+     * @default empty object
+     */
+    GroupProps?: GroupProps;
+    /**
+     * Other props
+     */
+    [p: string]: any;
+}
+/**
+ * > API documentation for the Community-JS Groups component. Learn about the available props and the CSS API.
+ *
+ *
+ * This component renders the list of the follows of the given group.
+ * Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-ui/Components/Groups)
+
+ #### Import
+
+ ```jsx
+ import {Groups} from '@selfcommunity/react-ui';
+ ```
+
+ #### Component Name
+
+ The name `SCGroups` can be used when providing style overrides in the theme.
+
+
+ #### CSS
+
+ |Rule Name|Global class|Description|
+ |---|---|---|
+ |root|.SCGroups-root|Styles applied to the root element.|
+ |title|.SCGroups-title|Styles applied to the title element.|
+ |noResults|.SCGroups-no-results|Styles applied to no results section.|
+ |showMore|.SCGroups-show-more|Styles applied to show more button element.|
+ |dialogRoot|.SCGroups-dialog-root|Styles applied to the dialog root element.|
+ |endMessage|.SCGroups-end-message|Styles applied to the end message element.|
+
+ * @param inProps
+ */
+export default function Groups(inProps: GroupsProps): JSX.Element;