@selfcommunity/react-ui 0.7.9-alpha.8 → 0.7.9-alpha.81

package/lib/cjs/components/Groups/Groups.js

@@ -14,9 +14,12 @@ const Errors_1 = require("../../constants/Errors");
 const system_1 = require("@mui/system");
 const HiddenPlaceholder_1 = tslib_1.__importDefault(require("../../shared/HiddenPlaceholder"));
 const constants_1 = require("./constants");
-const Group_1 = tslib_1.__importDefault(require("../Group"));
+const Group_1 = tslib_1.__importStar(require("../Group"));
+const Pagination_1 = require("../../constants/Pagination");
+const InfiniteScroll_1 = tslib_1.__importDefault(require("../../shared/InfiniteScroll"));
 const classes = {
     root: `${constants_1.PREFIX}-root`,
+    filters: `${constants_1.PREFIX}-filter`,
     groups: `${constants_1.PREFIX}-groups`,
     item: `${constants_1.PREFIX}-item`,
     noResults: `${constants_1.PREFIX}-no-results`,
@@ -64,10 +67,14 @@ function Groups(inProps) {
         props: inProps,
         name: constants_1.PREFIX
     });
-    const { endpoint, className, GroupComponentProps = { variant: 'outlined', ButtonBaseProps: { disableRipple: true, component: material_1.Box } }, prefetchedGroups = [] } = props, rest = tslib_1.__rest(props, ["endpoint", "className", "GroupComponentProps", "prefetchedGroups"]);
+    const { endpointQueryParams = { limit: 20, offset: Pagination_1.DEFAULT_PAGINATION_OFFSET }, className, GroupComponentProps = { variant: 'outlined', ButtonBaseProps: { disableRipple: true, component: material_1.Box } }, showFilters = false, filters, general = true } = props, rest = tslib_1.__rest(props, ["endpointQueryParams", "className", "GroupComponentProps", "showFilters", "filters", "general"]);
     // STATE
     const [groups, setGroups] = (0, react_1.useState)([]);
     const [loading, setLoading] = (0, react_1.useState)(true);
+    const [next, setNext] = (0, react_1.useState)(null);
+    const [search, setSearch] = (0, react_1.useState)('');
+    const theme = (0, material_1.useTheme)();
+    const isMobile = (0, material_1.useMediaQuery)(theme.breakpoints.down('md'));
     // CONTEXT
     const scUserContext = (0, react_core_1.useSCUser)();
     const scPreferencesContext = (0, react_core_1.useSCPreferences)();
@@ -76,19 +83,31 @@ function Groups(inProps) {
         scPreferencesContext.preferences[react_core_1.SCPreferences.CONFIGURATIONS_CONTENT_AVAILABILITY].value, [scPreferencesContext.preferences]);
     // CONST
     const authUserId = scUserContext.user ? scUserContext.user.id : null;
-    // REFS
-    const isMountedRef = (0, react_core_1.useIsComponentMountedRef)();
+    // HANDLERS
+    const handleScrollUp = () => {
+        window.scrollTo({ left: 0, top: 0, behavior: 'smooth' });
+    };
     /**
      * Fetches groups list
      */
-    const fetchGroups = (next = endpoint.url({})) => tslib_1.__awaiter(this, void 0, void 0, function* () {
-        const response = yield api_services_1.http.request({
-            url: next,
-            method: endpoint.method
+    const fetchGroups = () => {
+        let groupService;
+        if (general) {
+            groupService = api_services_1.GroupService.searchGroups(Object.assign(Object.assign({}, endpointQueryParams), (search !== '' && { search: search })));
+        }
+        else {
+            groupService = api_services_1.GroupService.getUserGroups(Object.assign(Object.assign({}, endpointQueryParams), (search !== '' && { search: search })));
+        }
+        groupService
+            .then((res) => {
+            setGroups(res.results);
+            setNext(res.next);
+            setLoading(false);
+        })
+            .catch((error) => {
+            utils_1.Logger.error(Errors_1.SCOPE_SC_UI, error);
         });
-        const data = response.data;
-        return data.next ? data.results.concat(yield fetchGroups(data.next)) : data.results;
-    });
+    };
     /**
      * On mount, fetches groups list
      */
@@ -96,33 +115,68 @@ function Groups(inProps) {
         if (!contentAvailability && !authUserId) {
             return;
         }
-        else if (prefetchedGroups.length) {
-            setGroups(prefetchedGroups);
-            setLoading(false);
-        }
         else {
-            fetchGroups()
-                .then((data) => {
-                if (isMountedRef.current) {
-                    setGroups(data);
-                    setLoading(false);
-                }
-            })
-                .catch((error) => {
-                utils_1.Logger.error(Errors_1.SCOPE_SC_UI, error);
-            });
+            fetchGroups();
+        }
+    }, [contentAvailability, authUserId, search]);
+    const handleNext = (0, react_1.useMemo)(() => () => {
+        if (!next) {
+            return;
         }
-    }, [contentAvailability, authUserId, prefetchedGroups.length]);
+        return api_services_1.http
+            .request({
+            url: next,
+            method: general ? api_services_1.Endpoints.SearchGroups.method : api_services_1.Endpoints.GetUserGroups.method
+        })
+            .then((res) => {
+            setGroups([...groups, ...res.data.results]);
+            setNext(res.data.next);
+        })
+            .catch((error) => console.log(error))
+            .then(() => setLoading(false));
+    }, [next]);
+    /**
+     * Get groups filtered
+     */
+    const getFilteredGroups = () => {
+        if (search) {
+            return groups.filter((g) => g.name.toLowerCase().includes(search.toLowerCase()));
+        }
+        return groups;
+    };
+    /**
+     * Handle change filter name
+     * @param event
+     */
+    const handleOnChangeFilterName = (event) => {
+        setSearch(event.target.value);
+    };
+    /**
+     * Renders groups list
+     */
+    const filteredGroups = (0, utils_1.sortByAttr)(getFilteredGroups(), 'order');
+    const content = (react_1.default.createElement(react_1.default.Fragment, null,
+        showFilters && (react_1.default.createElement(material_1.Grid, { container: true, direction: "row", justifyContent: "center", alignItems: "center", className: classes.filters }, filters ? (filters) : (react_1.default.createElement(material_1.Grid, { item: true, xs: 12, md: 6 },
+            react_1.default.createElement(material_1.TextField, { fullWidth: true, value: search, label: react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.groups.filterByName", defaultMessage: "ui.groups.filterByName" }), variant: "outlined", onChange: handleOnChangeFilterName, disabled: loading }))))),
+        react_1.default.createElement(react_1.default.Fragment, null, !groups.length ? (react_1.default.createElement(material_1.Box, { className: classes.noResults },
+            react_1.default.createElement(material_1.Typography, { variant: "h4" },
+                react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.groups.noGroups.title", defaultMessage: "ui.groups.noGroups.title" })),
+            react_1.default.createElement(material_1.Typography, { variant: "body1" },
+                react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.groups.noGroups.subtitle", defaultMessage: "ui.groups.noGroups.subtitle" })))) : (react_1.default.createElement(InfiniteScroll_1.default, { dataLength: groups.length, next: handleNext, hasMoreNext: Boolean(next), loaderNext: isMobile ? react_1.default.createElement(Group_1.GroupSkeleton, null) : react_1.default.createElement(Skeleton_1.default, { groupsNumber: 2 }), endMessage: react_1.default.createElement(material_1.Typography, { component: "div", className: classes.endMessage },
+                react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.groups.endMessage", defaultMessage: "ui.groups.endMessage", values: {
+                        // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
+                        // @ts-ignore
+                        button: (chunk) => (react_1.default.createElement(material_1.Button, { color: "secondary", variant: "text", onClick: handleScrollUp }, chunk))
+                    } })) },
+            react_1.default.createElement(material_1.Grid, { container: true, spacing: { xs: 2 }, className: classes.groups }, filteredGroups.map((group) => (react_1.default.createElement(material_1.Grid, { item: true, xs: 12, sm: 8, md: 6, key: group.id, className: classes.item },
+                react_1.default.createElement(Group_1.default, Object.assign({ group: group, groupId: group.id, actionRedirect: true }, GroupComponentProps)))))))))));
     // RENDER
     if (!contentAvailability && !scUserContext.user) {
         return react_1.default.createElement(HiddenPlaceholder_1.default, null);
     }
-    const content = (react_1.default.createElement(react_1.default.Fragment, null, loading ? (react_1.default.createElement(Skeleton_1.default, null)) : (react_1.default.createElement(material_1.Grid, { container: true, spacing: { xs: 3 }, className: classes.groups }, !groups.length ? (react_1.default.createElement(material_1.Box, { className: classes.noResults },
-        react_1.default.createElement(material_1.Typography, { variant: "h4" },
-            react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.groups.noGroups.title", defaultMessage: "ui.groups.noGroups.title" })),
-        react_1.default.createElement(material_1.Typography, { variant: "body1" },
-            react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.groups.noGroups.subtitle", defaultMessage: "ui.groups.noGroups.subtitle" })))) : (react_1.default.createElement(react_1.default.Fragment, null, groups.map((group) => (react_1.default.createElement(material_1.Grid, { item: true, xs: 12, sm: 8, md: 6, key: group.id, className: classes.item },
-        react_1.default.createElement(Group_1.default, Object.assign({ group: group, groupId: group.id }, GroupComponentProps)))))))))));
+    if (loading) {
+        return react_1.default.createElement(Skeleton_1.default, null);
+    }
     return (react_1.default.createElement(Root, Object.assign({ className: (0, classnames_1.default)(classes.root, className) }, rest), content));
 }
 exports.default = Groups;

package/lib/cjs/components/Groups/Skeleton.d.ts

@@ -9,6 +9,10 @@ export interface GroupsSkeletonProps {
      * @default null
      */
     GroupSkeletonProps?: any;
+    /**
+     * @default 20
+     */
+    groupsNumber?: number;
 }
 /**
  * > API documentation for the Community-JS Groups Skeleton component. Learn about the available props and the CSS API.

package/lib/cjs/components/Groups/Skeleton.js

@@ -37,9 +37,9 @@ const Root = (0, styles_1.styled)(material_1.Box, {
  *
  */
 function GroupsSkeleton(inProps) {
-    const { className, GroupSkeletonProps = {} } = inProps, rest = tslib_1.__rest(inProps, ["className", "GroupSkeletonProps"]);
+    const { className, GroupSkeletonProps = {}, groupsNumber = 20 } = inProps, rest = tslib_1.__rest(inProps, ["className", "GroupSkeletonProps", "groupsNumber"]);
     return (react_1.default.createElement(Root, Object.assign({ className: (0, classnames_1.default)(classes.root, className) }, rest),
-        react_1.default.createElement(material_1.Grid, { container: true, spacing: { xs: 3 }, className: classes.groups }, [...Array(15)].map((category, index) => (react_1.default.createElement(material_1.Grid, { item: true, xs: 12, sm: 8, md: 6, key: index },
+        react_1.default.createElement(material_1.Grid, { container: true, spacing: { xs: 3 }, className: classes.groups }, [...Array(groupsNumber)].map((category, index) => (react_1.default.createElement(material_1.Grid, { item: true, xs: 12, sm: 8, md: 6, key: index },
             react_1.default.createElement(Group_1.GroupSkeleton, Object.assign({ elevation: 0, variant: 'outlined' }, GroupSkeletonProps))))))));
 }
 exports.default = GroupsSkeleton;

package/lib/cjs/components/InlineComposerWidget/InlineComposerWidget.js

@@ -12,6 +12,7 @@ const system_1 = require("@mui/system");
 const Composer_1 = tslib_1.__importDefault(require("../Composer"));
 const Media_1 = require("../../shared/Media");
 const constants_1 = require("./constants");
+const HiddenPlaceholder_1 = tslib_1.__importDefault(require("../../shared/HiddenPlaceholder"));
 const classes = {
     root: `${constants_1.PREFIX}-root`,
     content: `${constants_1.PREFIX}-content`,
@@ -60,6 +61,9 @@ function InlineComposerWidget(inProps) {
     const scUserContext = (0, react_core_1.useSCUser)();
     const scRoutingContext = (0, react_core_1.useSCRouting)();
     const { enqueueSnackbar } = (0, notistack_1.useSnackbar)();
+    // PREFERENCES
+    const preferences = (0, react_core_1.useSCPreferences)();
+    const onlyStaffEnabled = (0, react_1.useMemo)(() => preferences.preferences[react_core_1.SCPreferences.CONFIGURATIONS_POST_ONLY_STAFF_ENABLED].value, [preferences.preferences]);
     // State variables
     const [open, setOpen] = (0, react_1.useState)(false);
     // Handlers
@@ -94,6 +98,9 @@ function InlineComposerWidget(inProps) {
         }
         setOpen(false);
     };
+    if (!react_core_1.UserUtils.isStaff(scUserContext.user) && onlyStaffEnabled) {
+        return react_1.default.createElement(HiddenPlaceholder_1.default, null);
+    }
     return (react_1.default.createElement(react_1.default.Fragment, null,
         react_1.default.createElement(Root, Object.assign({ className: classes.root }, rest),
             react_1.default.createElement(material_1.CardContent, { className: classes.content },

package/lib/cjs/components/NavigationSettingsIconButton/NavigationSettingsIconButton.js

@@ -4,7 +4,6 @@ const tslib_1 = require("tslib");
 const react_1 = tslib_1.__importStar(require("react"));
 const styles_1 = require("@mui/material/styles");
 const material_1 = require("@mui/material");
-const types_1 = require("@selfcommunity/types");
 const react_core_1 = require("@selfcommunity/react-core");
 const classnames_1 = tslib_1.__importDefault(require("classnames"));
 const system_1 = require("@mui/system");
@@ -36,7 +35,8 @@ const MenuRoot = (0, styles_1.styled)(material_1.Menu, {
 const PREFERENCES = [
     react_core_1.SCPreferences.CONFIGURATIONS_FOLLOW_ENABLED,
     react_core_1.SCPreferences.CONFIGURATIONS_POST_TYPE_ENABLED,
-    react_core_1.SCPreferences.CONFIGURATIONS_DISCUSSION_TYPE_ENABLED
+    react_core_1.SCPreferences.CONFIGURATIONS_DISCUSSION_TYPE_ENABLED,
+    react_core_1.SCPreferences.ADDONS_LOYALTY_POINTS_COLLECTION
 ];
 /**
  * > API documentation for the Community-JS Navigation Settings Icon Button component. Learn about the available props and the CSS API.
@@ -120,7 +120,7 @@ function NavigationSettingsIconButton(inProps) {
                 !preferences[react_core_1.SCPreferences.CONFIGURATIONS_FOLLOW_ENABLED] && (react_1.default.createElement(material_1.ListItem, { className: classes.item, key: "connections" },
                     react_1.default.createElement(material_1.ListItemButton, { component: react_core_1.Link, to: scRoutingContext.url(react_core_1.SCRoutes.USER_PROFILE_CONNECTIONS_ROUTE_NAME, scUserContext.user) },
                         react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.navigationSettingsIconButton.connections", defaultMessage: "ui.navigationSettingsIconButton.connections" })))),
-                scPreferences.features.includes(types_1.SCFeatureName.LOYALTY) && (react_1.default.createElement(material_1.ListItem, { className: classes.item, key: "loyaltyProgram" },
+                preferences[react_core_1.SCPreferences.ADDONS_LOYALTY_POINTS_COLLECTION] && (react_1.default.createElement(material_1.ListItem, { className: classes.item, key: "loyaltyProgram" },
                     react_1.default.createElement(material_1.ListItemButton, { component: react_core_1.Link, to: scRoutingContext.url(react_core_1.SCRoutes.LOYALTY_ROUTE_NAME, {}) },
                         react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.navigationSettingsIconButton.loyalty", defaultMessage: "ui.navigationSettingsIconButton.loyalty" })))),
                 preferences[react_core_1.SCPreferences.CONFIGURATIONS_POST_TYPE_ENABLED] && (react_1.default.createElement(material_1.ListItem, { className: classes.item, key: "followedPosts" },
@@ -169,7 +169,7 @@ function NavigationSettingsIconButton(inProps) {
                     react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.navigationSettingsIconButton.followers", defaultMessage: "ui.navigationSettingsIconButton.followers" }))),
                 !preferences[react_core_1.SCPreferences.CONFIGURATIONS_FOLLOW_ENABLED] && (react_1.default.createElement(material_1.MenuItem, { className: classes.item, key: "connections", component: react_core_1.Link, to: scRoutingContext.url(react_core_1.SCRoutes.USER_PROFILE_CONNECTIONS_ROUTE_NAME, scUserContext.user) },
                     react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.navigationSettingsIconButton.connections", defaultMessage: "ui.navigationSettingsIconButton.connections" }))),
-                scPreferences.features.includes(types_1.SCFeatureName.LOYALTY) && (react_1.default.createElement(material_1.MenuItem, { className: classes.item, key: "loyaltyProgram", component: react_core_1.Link, to: scRoutingContext.url(react_core_1.SCRoutes.LOYALTY_ROUTE_NAME, {}) },
+                preferences[react_core_1.SCPreferences.ADDONS_LOYALTY_POINTS_COLLECTION] && (react_1.default.createElement(material_1.MenuItem, { className: classes.item, key: "loyaltyProgram", component: react_core_1.Link, to: scRoutingContext.url(react_core_1.SCRoutes.LOYALTY_ROUTE_NAME, {}) },
                     react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.navigationSettingsIconButton.loyalty", defaultMessage: "ui.navigationSettingsIconButton.loyalty" }))),
                 preferences[react_core_1.SCPreferences.CONFIGURATIONS_POST_TYPE_ENABLED] && (react_1.default.createElement(material_1.MenuItem, { className: classes.item, key: "followedPosts", component: react_core_1.Link, to: scRoutingContext.url(react_core_1.SCRoutes.USER_PROFILE_FOLLOWED_POSTS_ROUTE_NAME, scUserContext.user) },
                     react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.navigationSettingsIconButton.postsFollowed", defaultMessage: "ui.navigationSettingsIconButton.postsFollowed" }))),

package/lib/cjs/components/NavigationToolbar/NavigationToolbar.js

@@ -102,6 +102,11 @@ function NavigationToolbar(inProps) {
     }, [scPreferences.preferences]);
     const privateMessagingEnabled = (0, react_1.useMemo)(() => scPreferences.features.includes(types_1.SCFeatureName.PRIVATE_MESSAGING), [scPreferences.features]);
     const groupsEnabled = (0, react_1.useMemo)(() => scPreferences.features.includes(types_1.SCFeatureName.GROUPING), [scPreferences.features]);
+    const showComposer = (0, react_1.useMemo)(() => {
+        return (scPreferences.preferences[react_core_1.SCPreferences.CONFIGURATIONS_POST_ONLY_STAFF_ENABLED].value &&
+            !disableComposer &&
+            (!scPreferences.preferences[react_core_1.SCPreferences.CONFIGURATIONS_POST_ONLY_STAFF_ENABLED].value || react_core_1.UserUtils.isStaff(scUserContext.user)));
+    }, [scPreferences, disableComposer, scUserContext.user]);
     // STATE
     const [anchorNotification, setAnchorNotification] = react_1.default.useState(null);
     // HANDLERS
@@ -123,7 +128,9 @@ function NavigationToolbar(inProps) {
         preferences[react_core_1.SCPreferences.CONFIGURATIONS_EXPLORE_STREAM_ENABLED] &&
             (preferences[react_core_1.SCPreferences.CONFIGURATIONS_CONTENT_AVAILABILITY] || scUserContext.user) && (react_1.default.createElement(material_1.IconButton, { className: (0, classnames_1.default)(classes.explore, { [classes.active]: value.startsWith(scRoutingContext.url(react_core_1.SCRoutes.EXPLORE_ROUTE_NAME, {})) }), "aria-label": "Explore", to: scRoutingContext.url(react_core_1.SCRoutes.EXPLORE_ROUTE_NAME, {}), component: react_core_1.Link },
             react_1.default.createElement(Icon_1.default, null, "explore"))),
-        groupsEnabled && scUserContext.user && (react_1.default.createElement(material_1.IconButton, { className: (0, classnames_1.default)(classes.groups, { [classes.active]: value.startsWith(scRoutingContext.url(react_core_1.SCRoutes.GROUPS_ROUTE_NAME, {})) }), "aria-label": "Groups", to: scRoutingContext.url(react_core_1.SCRoutes.GROUPS_ROUTE_NAME, {}), component: react_core_1.Link },
+        groupsEnabled && scUserContext.user && (react_1.default.createElement(material_1.IconButton, { className: (0, classnames_1.default)(classes.groups, {
+                [classes.active]: value.startsWith(scRoutingContext.url(react_core_1.SCRoutes.GROUPS_SUBSCRIBED_ROUTE_NAME, {}))
+            }), "aria-label": "Groups", to: scRoutingContext.url(react_core_1.SCRoutes.GROUPS_SUBSCRIBED_ROUTE_NAME, {}), component: react_core_1.Link },
             react_1.default.createElement(Icon_1.default, null, "groups")))));
     return (react_1.default.createElement(Root, Object.assign({ className: (0, classnames_1.default)(className, classes.root) }, rest),
         react_1.default.createElement(NavigationMenuIconButtonComponent, null),
@@ -135,7 +142,7 @@ function NavigationToolbar(inProps) {
         (preferences[react_core_1.SCPreferences.CONFIGURATIONS_CONTENT_AVAILABILITY] || scUserContext.user) && !disableSearch ? (react_1.default.createElement(SearchAutocomplete_1.default, Object.assign({ className: classes.search, blurOnSelect: true }, SearchAutocompleteProps))) : (react_1.default.createElement(material_1.Box, { className: classes.search })),
         startActions,
         scUserContext.user ? (react_1.default.createElement(react_1.default.Fragment, null,
-            !disableComposer && react_1.default.createElement(ComposerIconButton_1.default, Object.assign({ className: classes.composer }, ComposerIconButtonProps)),
+            showComposer && react_1.default.createElement(ComposerIconButton_1.default, Object.assign({ className: classes.composer }, ComposerIconButtonProps)),
             react_1.default.createElement(material_1.Tooltip, { title: scUserContext.user.username },
                 react_1.default.createElement(material_1.IconButton, { component: react_core_1.Link, to: scRoutingContext.url(react_core_1.SCRoutes.USER_PROFILE_ROUTE_NAME, scUserContext.user), "aria-label": "Profile", className: classes.profile },
                     react_1.default.createElement(material_1.Avatar, { alt: scUserContext.user.username, src: scUserContext.user.avatar }))),

package/lib/cjs/components/NavigationToolbarMobile/NavigationToolbarMobile.d.ts

@@ -59,6 +59,7 @@ export interface NavigationToolbarMobileProps extends ToolbarProps {
  |logo|.SCNavigationToolbarMobile-logo|Styles applied to the logo element.|
  |search|.SCNavigationToolbarMobile-search|Styles applied to the search button element|
  |searchDialog|.SCNavigationToolbarMobile-search-dialog|Styles applied to the search dialog element|
+ |notifications|.SCNavigationToolbarMobile-notifications|Styles applied to the notifications button element|
  |settings|.SCNavigationToolbarMobile-settings|Styles applied to the settings button element|
  |settingsDialog|.SCNavigationToolbarMobile-settingsDialog|Styles applied to the settings dialog elements|
  |login|.SCNavigationToolbarMobile-login|Styles applied to the login element.|

package/lib/cjs/components/NavigationToolbarMobile/NavigationToolbarMobile.js

@@ -13,11 +13,13 @@ const SearchDialog_1 = tslib_1.__importDefault(require("../SearchDialog"));
 const NavigationSettingsIconButton_1 = tslib_1.__importDefault(require("../NavigationSettingsIconButton"));
 const NavigationMenuIconButton_1 = tslib_1.__importDefault(require("../NavigationMenuIconButton"));
 const constants_1 = require("./constants");
+const types_1 = require("@selfcommunity/types");
 const classes = {
     root: `${constants_1.PREFIX}-root`,
     logo: `${constants_1.PREFIX}-logo`,
     search: `${constants_1.PREFIX}-search`,
     searchDialog: `${constants_1.PREFIX}-search-dialog`,
+    notifications: `${constants_1.PREFIX}-notifications`,
     settings: `${constants_1.PREFIX}-settings`,
     settingsDialog: `${constants_1.PREFIX}-settings-dialog`,
     login: `${constants_1.PREFIX}-login`
@@ -52,6 +54,7 @@ const Root = (0, material_1.styled)(material_1.Toolbar, {
  |logo|.SCNavigationToolbarMobile-logo|Styles applied to the logo element.|
  |search|.SCNavigationToolbarMobile-search|Styles applied to the search button element|
  |searchDialog|.SCNavigationToolbarMobile-search-dialog|Styles applied to the search dialog element|
+ |notifications|.SCNavigationToolbarMobile-notifications|Styles applied to the notifications button element|
  |settings|.SCNavigationToolbarMobile-settings|Styles applied to the settings button element|
  |settingsDialog|.SCNavigationToolbarMobile-settingsDialog|Styles applied to the settings dialog elements|
  |login|.SCNavigationToolbarMobile-login|Styles applied to the login element.|
@@ -69,9 +72,11 @@ function NavigationToolbarMobile(inProps) {
     const scUserContext = (0, react_core_1.useSCUser)();
     const scRoutingContext = (0, react_core_1.useSCRouting)();
     // PREFERENCES
-    const { preferences } = (0, react_core_1.useSCPreferences)();
+    const { preferences, features } = (0, react_core_1.useSCPreferences)();
     // STATE
     const [searchOpen, setSearchOpen] = (0, react_1.useState)(false);
+    // MEMO
+    const groupsEnabled = (0, react_1.useMemo)(() => features.includes(types_1.SCFeatureName.GROUPING), [features]);
     // HANDLERS
     const handleOpenSearch = (0, react_1.useCallback)(() => {
         setSearchOpen(true);
@@ -94,6 +99,9 @@ function NavigationToolbarMobile(inProps) {
                 react_1.default.createElement(Icon_1.default, null, "search")),
             react_1.default.createElement(SearchDialog_1.default, { className: classes.searchDialog, fullScreen: true, open: searchOpen, SearchAutocompleteProps: Object.assign(Object.assign({}, SearchAutocompleteProps), { onClear: handleCloseSearch }) }))),
         endActions,
+        scUserContext.user && groupsEnabled && (react_1.default.createElement(material_1.IconButton, { className: classes.notifications, component: react_core_1.Link, to: scRoutingContext.url(react_core_1.SCRoutes.USER_NOTIFICATIONS_ROUTE_NAME, {}) },
+            react_1.default.createElement(material_1.Badge, { badgeContent: scUserContext.user.unseen_notification_banners_counter + scUserContext.user.unseen_interactions_counter, color: "secondary" },
+                react_1.default.createElement(Icon_1.default, null, "notifications_active")))),
         scUserContext.user ? (react_1.default.createElement(NavigationSettingsIconButtonComponent, { className: classes.settings })) : (react_1.default.createElement(material_1.Button, { className: classes.login, color: "inherit", component: react_core_1.Link, to: scRoutingContext.url(react_core_1.SCRoutes.SIGNIN_ROUTE_NAME, {}) },
             react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.appBar.navigation.login", defaultMessage: "ui.appBar.navigation.login" })))));
 }

package/lib/cjs/components/Notification/Group/Group.d.ts

@@ -0,0 +1,15 @@
+import { SCNotificationGroupActivityType } from '@selfcommunity/types';
+import { NotificationItemProps } from '../../../shared/NotificationItem';
+export interface NotificationGroupProps extends Pick<NotificationItemProps, Exclude<keyof NotificationItemProps, 'image' | 'disableTypography' | 'primary' | 'primaryTypographyProps' | 'secondary' | 'secondaryTypographyProps' | 'actions' | 'footer' | 'isNew'>> {
+    /**
+     * Notification obj
+     * @default null
+     */
+    notificationObject: SCNotificationGroupActivityType;
+}
+/**
+ * This component render the content of the notification of type group
+ * @constructor
+ * @param props
+ */
+export default function GroupNotification(props: NotificationGroupProps): JSX.Element;

package/lib/cjs/components/Notification/Group/Group.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const react_1 = tslib_1.__importStar(require("react"));
+const styles_1 = require("@mui/material/styles");
+const material_1 = require("@mui/material");
+const react_core_1 = require("@selfcommunity/react-core");
+const types_1 = require("@selfcommunity/types");
+const react_intl_1 = require("react-intl");
+const DateTimeAgo_1 = tslib_1.__importDefault(require("../../../shared/DateTimeAgo"));
+const classnames_1 = tslib_1.__importDefault(require("classnames"));
+const types_2 = require("../../../types");
+const NotificationItem_1 = tslib_1.__importDefault(require("../../../shared/NotificationItem"));
+const lab_1 = require("@mui/lab");
+const UserDeletedSnackBar_1 = tslib_1.__importDefault(require("../../../shared/UserDeletedSnackBar"));
+const UserAvatar_1 = tslib_1.__importDefault(require("../../../shared/UserAvatar"));
+const constants_1 = require("../constants");
+const classes = {
+    root: `${constants_1.PREFIX}-group-root`,
+    avatar: `${constants_1.PREFIX}-avatar`,
+    actions: `${constants_1.PREFIX}-actions`,
+    acceptButton: `${constants_1.PREFIX}-reply-button`,
+    activeAt: `${constants_1.PREFIX}-active-at`,
+    username: `${constants_1.PREFIX}-username`
+};
+const Root = (0, styles_1.styled)(NotificationItem_1.default, {
+    name: constants_1.PREFIX,
+    slot: 'GroupRoot'
+})(() => ({}));
+/**
+ * This component render the content of the notification of type group
+ * @constructor
+ * @param props
+ */
+function GroupNotification(props) {
+    // PROPS
+    const { notificationObject, id = `n_${props.notificationObject['sid']}`, className, template = types_2.SCNotificationObjectTemplateType.DETAIL } = props, rest = tslib_1.__rest(props, ["notificationObject", "id", "className", "template"]);
+    // CONTEXT
+    const scRoutingContext = (0, react_core_1.useSCRouting)();
+    const scUserContext = (0, react_1.useContext)(react_core_1.SCUserContext);
+    const manager = scUserContext.managers.groups;
+    // STATE
+    const [status, setStatus] = (0, react_1.useState)(null);
+    const [openAlert, setOpenAlert] = (0, react_1.useState)(false);
+    // CONST
+    const isSnippetTemplate = template === types_2.SCNotificationObjectTemplateType.SNIPPET;
+    const isToastTemplate = template === types_2.SCNotificationObjectTemplateType.TOAST;
+    (0, react_1.useEffect)(() => {
+        setStatus(manager.subscriptionStatus(notificationObject.group));
+    }, [manager.subscriptionStatus, notificationObject.group]);
+    // RENDER
+    if (isSnippetTemplate || isToastTemplate) {
+        return (react_1.default.createElement(Root, Object.assign({ id: id, className: (0, classnames_1.default)(classes.root, className, `${constants_1.PREFIX}-${template}`), template: template, isNew: notificationObject.is_new, disableTypography: true, image: react_1.default.createElement(react_core_1.Link, Object.assign({}, (!notificationObject.user.deleted && {
+                to: scRoutingContext.url(react_core_1.SCRoutes.USER_PROFILE_ROUTE_NAME, notificationObject.user)
+            }), { onClick: notificationObject.user.deleted ? () => setOpenAlert(true) : null }),
+                react_1.default.createElement(UserAvatar_1.default, { hide: !notificationObject.user.community_badge, smaller: true },
+                    react_1.default.createElement(material_1.Avatar, { alt: notificationObject.user.username, variant: "circular", src: notificationObject.user.avatar, classes: { root: classes.avatar } }))), primary: react_1.default.createElement(material_1.Box, null,
+                react_1.default.createElement(react_core_1.Link, Object.assign({}, (!notificationObject.user.deleted && {
+                    to: scRoutingContext.url(react_core_1.SCRoutes.USER_PROFILE_ROUTE_NAME, notificationObject.user)
+                }), { onClick: notificationObject.user.deleted ? () => setOpenAlert(true) : null, className: classes.username }), notificationObject.user.username),
+                ' ',
+                react_1.default.createElement(react_intl_1.FormattedMessage, { id: `ui.notification.${notificationObject.type}`, defaultMessage: `ui.notification.${notificationObject.type}`, values: {
+                        group: notificationObject.group.name,
+                        link: (...chunks) => react_1.default.createElement(react_core_1.Link, { to: scRoutingContext.url(react_core_1.SCRoutes.GROUP_ROUTE_NAME, notificationObject.group) }, chunks)
+                    } })), footer: isToastTemplate && (react_1.default.createElement(material_1.Stack, { direction: "row", justifyContent: "space-between", alignItems: "center", spacing: 2 },
+                react_1.default.createElement(DateTimeAgo_1.default, { date: notificationObject.active_at }),
+                status && status !== types_1.SCGroupSubscriptionStatusType.SUBSCRIBED && (react_1.default.createElement(material_1.Typography, { color: "primary" },
+                    react_1.default.createElement(react_core_1.Link, { to: scRoutingContext.url(react_core_1.SCRoutes.GROUP_ROUTE_NAME, notificationObject.group) },
+                        react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.notification.group.button.see", defaultMessage: "ui.notification.group.button.see" })))))) }, rest)));
+    }
+    return (react_1.default.createElement(react_1.default.Fragment, null,
+        react_1.default.createElement(Root, Object.assign({ id: id, className: (0, classnames_1.default)(classes.root, className, `${constants_1.PREFIX}-${template}`), template: template, isNew: notificationObject.is_new, disableTypography: true, actions: react_1.default.createElement(material_1.Stack, { direction: "row", justifyContent: "space-between", alignItems: "center", spacing: 2 },
+                react_1.default.createElement(DateTimeAgo_1.default, { date: notificationObject.active_at, className: classes.activeAt }),
+                status && status !== types_1.SCGroupSubscriptionStatusType.SUBSCRIBED && (react_1.default.createElement(lab_1.LoadingButton, { color: 'primary', variant: "outlined", size: "small", classes: { root: classes.acceptButton }, component: react_core_1.Link, loading: scUserContext.user ? status === null || manager.isLoading(notificationObject.group) : null, to: scRoutingContext.url(react_core_1.SCRoutes.GROUP_ROUTE_NAME, notificationObject.group) },
+                    react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.notification.group.button.see", defaultMessage: "ui.notification.group.button.see" })))) }, rest)),
+        openAlert && react_1.default.createElement(UserDeletedSnackBar_1.default, { open: openAlert, handleClose: () => setOpenAlert(false) })));
+}
+exports.default = GroupNotification;

package/lib/cjs/components/Notification/Group/index.d.ts

@@ -0,0 +1,3 @@
+import GroupNotification, { NotificationGroupProps } from './Group';
+export default GroupNotification;
+export { NotificationGroupProps };

package/lib/cjs/components/Notification/Group/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const Group_1 = tslib_1.__importDefault(require("./Group"));
+exports.default = Group_1.default;

package/lib/cjs/components/Notification/Notification.js

@@ -35,6 +35,7 @@ const types_1 = require("@selfcommunity/types");
 const UserDeletedSnackBar_1 = tslib_1.__importDefault(require("../../shared/UserDeletedSnackBar"));
 const UserAvatar_1 = tslib_1.__importDefault(require("../../shared/UserAvatar"));
 const constants_1 = require("./constants");
+const Group_1 = tslib_1.__importDefault(require("./Group"));
 const messages = (0, react_intl_1.defineMessages)({
     receivePrivateMessage: {
         id: 'ui.notification.receivePrivateMessage',
@@ -151,7 +152,7 @@ function UserNotification(inProps) {
     }
     /**
      * Handles vote
-     * @param comment
+     * @param index
      */
     const handleVote = (index) => {
         return (contribution) => {
@@ -196,6 +197,29 @@ function UserNotification(inProps) {
                         b: (...chunks) => react_1.default.createElement("strong", null, chunks)
                     })) }));
         }
+        /**
+         * Group notifications header
+         */
+        if (notificationObject.aggregated &&
+            (notificationObject.aggregated[0].type === types_1.SCNotificationTypologyType.USER_INVITED_TO_JOIN_GROUP ||
+                notificationObject.aggregated[0].type === types_1.SCNotificationTypologyType.USER_ACCEPTED_TO_JOIN_GROUP ||
+                notificationObject.aggregated[0].type === types_1.SCNotificationTypologyType.USER_ADDED_TO_GROUP ||
+                notificationObject.aggregated[0].type === types_1.SCNotificationTypologyType.USER_REQUESTED_TO_JOIN_GROUP)) {
+            let groupNotification = notificationObject.aggregated[0];
+            return (react_1.default.createElement(material_1.CardHeader, { className: classes.header, avatar: react_1.default.createElement(react_core_1.Link, Object.assign({}, (!groupNotification.user.deleted && {
+                    to: scRoutingContext.url(react_core_1.SCRoutes.USER_PROFILE_ROUTE_NAME, groupNotification.user)
+                }), { onClick: groupNotification.user.deleted ? () => setOpenAlert(true) : null }),
+                    react_1.default.createElement(UserAvatar_1.default, { hide: !groupNotification.user.community_badge, smaller: true },
+                        react_1.default.createElement(material_1.Avatar, { className: classes.avatar, alt: groupNotification.user.username, variant: "circular", src: groupNotification.user.avatar }))), titleTypographyProps: { className: classes.title, variant: 'subtitle1' }, title: react_1.default.createElement(react_1.default.Fragment, null,
+                    react_1.default.createElement(react_core_1.Link, Object.assign({}, (!groupNotification.user.deleted && {
+                        to: scRoutingContext.url(react_core_1.SCRoutes.USER_PROFILE_ROUTE_NAME, groupNotification.user)
+                    }), { onClick: groupNotification.user.deleted ? () => setOpenAlert(true) : null, className: classes.username }), groupNotification.user.username),
+                    ' ',
+                    react_1.default.createElement(react_intl_1.FormattedMessage, { id: `ui.notification.${notificationObject.aggregated[0].type}`, defaultMessage: `ui.notification.${notificationObject.aggregated[0].type}`, values: {
+                            group: groupNotification.group.name,
+                            link: (...chunks) => react_1.default.createElement(react_core_1.Link, { to: scRoutingContext.url(react_core_1.SCRoutes.GROUP_ROUTE_NAME, groupNotification.group) }, chunks)
+                        } })) }));
+        }
         /**
          * Comment, NestedComment, Follow Contribution header
          */
@@ -278,6 +302,12 @@ function UserNotification(inProps) {
         else if (n.type === types_1.SCNotificationTypologyType.CONTRIBUTION) {
             return react_1.default.createElement(Contribution_1.default, { notificationObject: n, key: i, onVote: handleVote(i) });
         }
+        else if (n.type === types_1.SCNotificationTypologyType.USER_ADDED_TO_GROUP ||
+            n.type === types_1.SCNotificationTypologyType.USER_INVITED_TO_JOIN_GROUP ||
+            n.type === types_1.SCNotificationTypologyType.USER_ACCEPTED_TO_JOIN_GROUP ||
+            n.type === types_1.SCNotificationTypologyType.USER_REQUESTED_TO_JOIN_GROUP) {
+            return react_1.default.createElement(Group_1.default, { notificationObject: n, key: i });
+        }
         return null;
     }
     /**

package/lib/cjs/components/Notification/PrivateMessage/PrivateMessage.js

@@ -41,6 +41,7 @@ const Root = (0, styles_1.styled)(NotificationItem_1.default, {
  * @param props
  */
 function PrivateMessageNotification(props) {
+    var _a, _b, _c, _d, _e;
     // PROPS
     const { notificationObject, id = `n_${props.notificationObject['sid']}`, className, template = types_1.SCNotificationObjectTemplateType.DETAIL } = props, rest = tslib_1.__rest(props, ["notificationObject", "id", "className", "template"]);
     // CONTEXT
@@ -91,7 +92,9 @@ function PrivateMessageNotification(props) {
                     react_1.default.createElement(react_intl_1.FormattedMessage, { id: 'ui.userToastNotifications.privateMessage.sentMessage', defaultMessage: 'ui.userToastNotifications.privateMessage.sentMessage' }),
                     ":",
                     react_1.default.createElement(material_1.Box, { className: classes.messageWrap },
-                        react_1.default.createElement(react_core_1.Link, { to: scRoutingContext.url(react_core_1.SCRoutes.USER_PRIVATE_MESSAGES_ROUTE_NAME, notificationObject.message.sender), className: classes.message },
+                        react_1.default.createElement(react_core_1.Link, { to: ((_a = notificationObject.message) === null || _a === void 0 ? void 0 : _a.group)
+                                ? scRoutingContext.url(react_core_1.SCRoutes.GROUP_MESSAGES_ROUTE_NAME, notificationObject.message.group)
+                                : scRoutingContext.url(react_core_1.SCRoutes.USER_PRIVATE_MESSAGES_ROUTE_NAME, notificationObject.message.sender), className: classes.message },
                             react_1.default.createElement(material_1.Typography, { variant: "body2", dangerouslySetInnerHTML: { __html: notificationObject.message.message } }))))),
                 isSnippetTemplate && (react_1.default.createElement(material_1.Box, null,
                     react_1.default.createElement(material_1.Typography, { component: "div", color: "inherit" },
@@ -99,13 +102,17 @@ function PrivateMessageNotification(props) {
                             to: scRoutingContext.url(react_core_1.SCRoutes.USER_PROFILE_ROUTE_NAME, notificationObject.message.sender)
                         }), { onClick: notificationObject.message.sender.deleted ? () => setOpenAlert(true) : null, className: classes.username }), notificationObject.message.sender.username),
                         ' ',
-                        react_1.default.createElement(react_core_1.Link, { to: scRoutingContext.url(react_core_1.SCRoutes.USER_PRIVATE_MESSAGES_ROUTE_NAME, notificationObject.message.sender), className: classes.messageLabel }, intl.formatMessage(messages.receivePrivateMessage, {
+                        react_1.default.createElement(react_core_1.Link, { to: ((_b = notificationObject.message) === null || _b === void 0 ? void 0 : _b.group)
+                                ? scRoutingContext.url(react_core_1.SCRoutes.GROUP_MESSAGES_ROUTE_NAME, notificationObject.message.group)
+                                : scRoutingContext.url(react_core_1.SCRoutes.USER_PRIVATE_MESSAGES_ROUTE_NAME, notificationObject.message.sender), className: classes.messageLabel }, intl.formatMessage(messages.receivePrivateMessage, {
                             total: 1,
                             b: (...chunks) => react_1.default.createElement("strong", null, chunks)
                         })))))), footer: isToastTemplate && (react_1.default.createElement(material_1.Stack, { direction: "row", justifyContent: "space-between", alignItems: "center", spacing: 2 },
                 react_1.default.createElement(DateTimeAgo_1.default, { date: notificationObject.active_at }),
                 react_1.default.createElement(material_1.Typography, { color: "primary" },
-                    react_1.default.createElement(react_core_1.Link, { to: scRoutingContext.url(react_core_1.SCRoutes.USER_PRIVATE_MESSAGES_ROUTE_NAME, notificationObject.message.sender) }, scUserContext.user && follower ? (react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.userToastNotifications.replyMessage", defaultMessage: 'ui.userToastNotifications.replyMessage' })) : (react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.userToastNotifications.viewMessage", defaultMessage: 'ui.userToastNotifications.viewMessage' })))))) }, rest)));
+                    react_1.default.createElement(react_core_1.Link, { to: ((_c = notificationObject.message) === null || _c === void 0 ? void 0 : _c.group)
+                            ? scRoutingContext.url(react_core_1.SCRoutes.GROUP_MESSAGES_ROUTE_NAME, notificationObject.message.group)
+                            : scRoutingContext.url(react_core_1.SCRoutes.USER_PRIVATE_MESSAGES_ROUTE_NAME, notificationObject.message.sender) }, scUserContext.user && follower ? (react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.userToastNotifications.replyMessage", defaultMessage: 'ui.userToastNotifications.replyMessage' })) : (react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.userToastNotifications.viewMessage", defaultMessage: 'ui.userToastNotifications.viewMessage' })))))) }, rest)));
     }
     return (react_1.default.createElement(react_1.default.Fragment, null,
         react_1.default.createElement(Root, Object.assign({ id: id, className: (0, classnames_1.default)(classes.root, className, `${constants_1.PREFIX}-${template}`), template: template, isNew: notificationObject.is_new, disableTypography: true, actions: react_1.default.createElement(material_1.Stack, { direction: "row", justifyContent: "space-between", alignItems: "center", spacing: 2 },
@@ -114,8 +121,12 @@ function PrivateMessageNotification(props) {
                         ? null
                         : scUserContext.user
                             ? follower === null || manager.isLoading(notificationObject.message.sender)
-                            : null, to: scRoutingContext.url(react_core_1.SCRoutes.USER_PRIVATE_MESSAGES_ROUTE_NAME, notificationObject.message.sender) }, scUserContext.user && follower ? (react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.notification.privateMessage.btnReplyLabel", defaultMessage: "ui.notification.privateMessage.btnReplyLabel" })) : (react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.notification.privateMessage.btnViewLabel", defaultMessage: "ui.notification.privateMessage.btnViewLabel" })))), primary: react_1.default.createElement(material_1.Box, { className: classes.messageWrap },
-                react_1.default.createElement(react_core_1.Link, { to: scRoutingContext.url(react_core_1.SCRoutes.USER_PRIVATE_MESSAGES_ROUTE_NAME, notificationObject.message.sender), className: classes.message },
+                            : null, to: ((_d = notificationObject.message) === null || _d === void 0 ? void 0 : _d.group)
+                        ? scRoutingContext.url(react_core_1.SCRoutes.GROUP_MESSAGES_ROUTE_NAME, notificationObject.message.group)
+                        : scRoutingContext.url(react_core_1.SCRoutes.USER_PRIVATE_MESSAGES_ROUTE_NAME, notificationObject.message.sender) }, scUserContext.user && follower ? (react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.notification.privateMessage.btnReplyLabel", defaultMessage: "ui.notification.privateMessage.btnReplyLabel" })) : (react_1.default.createElement(react_intl_1.FormattedMessage, { id: "ui.notification.privateMessage.btnViewLabel", defaultMessage: "ui.notification.privateMessage.btnViewLabel" })))), primary: react_1.default.createElement(material_1.Box, { className: classes.messageWrap },
+                react_1.default.createElement(react_core_1.Link, { to: ((_e = notificationObject.message) === null || _e === void 0 ? void 0 : _e.group)
+                        ? scRoutingContext.url(react_core_1.SCRoutes.GROUP_MESSAGES_ROUTE_NAME, notificationObject.message.group)
+                        : scRoutingContext.url(react_core_1.SCRoutes.USER_PRIVATE_MESSAGES_ROUTE_NAME, notificationObject.message.sender), className: classes.message },
                     react_1.default.createElement(material_1.Typography, { variant: "body2", dangerouslySetInnerHTML: { __html: notificationObject.message.message } }))) }, rest)),
         openAlert && react_1.default.createElement(UserDeletedSnackBar_1.default, { open: openAlert, handleClose: () => setOpenAlert(false) })));
 }

package/lib/cjs/components/PrivateMessageComponent/PrivateMessageComponent.d.ts

@@ -1,14 +1,20 @@
+import { SCPrivateMessageType } from '@selfcommunity/types';
 export interface PrivateMessageComponentProps {
     /**
      * Thread receiver id
      * @default null
      */
     id?: number | string;
+    /**
+     * Thread type
+     * @default null
+     */
+    type?: SCPrivateMessageType;
     /**
      * Handler on message click
      * @default null
      */
-    onItemClick?: (id: any) => void;
+    onItemClick?: (id: any, type: any) => void;
     /**
      * Handler on single message open
      * @default null