@livetiles/reach-components-react 0.4.86 → 0.4.88

package/index.d.ts

@@ -64,47 +64,6 @@ declare type ReachContextProps = {
 };
 declare const ReachContextProvider: FC<ReachContextProps>;
 
-interface NewsDetailProps {
-    itemId?: string;
-    hideComments?: boolean;
-    hideLikes?: boolean;
-    preventExternalContentAutoRedirect?: boolean;
-    onChannelClick?: (channel: string) => unknown;
-    onKeywordClick?: (keyword: string) => unknown;
-    className?: string;
-}
-declare const NewsDetail: FC<NewsDetailProps>;
-
-interface PageDetailProps {
-    itemId?: string;
-    hideComments?: boolean;
-    hideLikes?: boolean;
-    preventExternalContentAutoRedirect?: boolean;
-    homeBreadcrumbTargetUrl?: string;
-    onKeywordClick?: (keyword: string) => unknown;
-    className?: string;
-}
-declare const PageDetail: FC<PageDetailProps>;
-
-interface EventDetailProps {
-    itemId?: string;
-    hideComments?: boolean;
-    hideLikes?: boolean;
-    onChannelClick?: (channel: string) => unknown;
-    onKeywordClick?: (keyword: string) => unknown;
-    className?: string;
-}
-declare const EventDetail: FC<EventDetailProps>;
-
-interface PostDetailProps {
-    postId: string;
-    threadId?: string;
-    onAfterDelete?: (id: string) => unknown;
-    commentCount?: number;
-    onItemClick?: (postId: string) => unknown;
-}
-declare const PostDetail: FC<PostDetailProps>;
-
 interface PaginatedList<TItem> {
     items: TItem[];
     paginationToken?: any;
@@ -256,6 +215,39 @@ interface LanguageBase {
     code: string;
 }
 
+interface KeywordGroup {
+    id: string;
+    name: string;
+    keywords: Keyword[];
+    translations: {
+        [key: string]: string;
+    };
+}
+interface Keyword {
+    id: string;
+    name: string;
+    groupId?: string;
+    translations: {
+        [key: string]: string;
+    };
+}
+
+interface Channel {
+    id: string;
+    name: string;
+    translations?: {
+        [key: string]: string;
+    };
+}
+
+declare enum ItemResourceTypes {
+    News = "news",
+    Pages = "pages",
+    Posts = "posts",
+    Events = "events",
+    Comments = "comments"
+}
+
 interface DirectoryConfiguration extends DirectoryConfigurationPatch {
     domains?: string[];
     tenantId: string;
@@ -416,31 +408,6 @@ declare enum FieldMode {
     Hidden = 3
 }
 
-interface Channel {
-    id: string;
-    name: string;
-    translations?: {
-        [key: string]: string;
-    };
-}
-
-interface KeywordGroup {
-    id: string;
-    name: string;
-    keywords: Keyword[];
-    translations: {
-        [key: string]: string;
-    };
-}
-interface Keyword {
-    id: string;
-    name: string;
-    groupId?: string;
-    translations: {
-        [key: string]: string;
-    };
-}
-
 interface ItemStatistics {
     commentCount?: number;
     likeCount?: number;
@@ -689,14 +656,6 @@ declare enum ConversationScope {
     Posts = 2
 }
 
-declare enum ItemResourceTypes {
-    News = "news",
-    Pages = "pages",
-    Posts = "posts",
-    Events = "events",
-    Comments = "comments"
-}
-
 declare enum EventResponse {
     NotSet = 0,
     Registered = 1,
@@ -861,6 +820,47 @@ interface LazySubscriptionContextType extends SubscriptionData {
 
 declare function useLazySubscriptionContext(): LazySubscriptionContextType;
 
+interface NewsDetailProps {
+    itemId?: string;
+    hideComments?: boolean;
+    hideLikes?: boolean;
+    preventExternalContentAutoRedirect?: boolean;
+    onChannelClick?: (channelName: string, channelItem?: Channel) => unknown;
+    onKeywordClick?: (keywordId: string, keywordItem?: Keyword) => unknown;
+    className?: string;
+}
+declare const NewsDetail: FC<NewsDetailProps>;
+
+interface PageDetailProps {
+    itemId?: string;
+    hideComments?: boolean;
+    hideLikes?: boolean;
+    preventExternalContentAutoRedirect?: boolean;
+    homeBreadcrumbTargetUrl?: string;
+    onKeywordClick?: (keywordId: string, keywordItem?: Keyword) => unknown;
+    className?: string;
+}
+declare const PageDetail: FC<PageDetailProps>;
+
+interface EventDetailProps {
+    itemId?: string;
+    hideComments?: boolean;
+    hideLikes?: boolean;
+    onChannelClick?: (channelName: string, channelItem?: Channel) => unknown;
+    onKeywordClick?: (keywordId: string, keywordItem?: Keyword) => unknown;
+    className?: string;
+}
+declare const EventDetail: FC<EventDetailProps>;
+
+interface PostDetailProps {
+    postId: string;
+    threadId?: string;
+    onAfterDelete?: (id: string) => unknown;
+    commentCount?: number;
+    onItemClick?: (postId: string) => unknown;
+}
+declare const PostDetail: FC<PostDetailProps>;
+
 declare const Dialog: FC<IDialogProps>;
 
 interface ToolbarProps {
@@ -1127,7 +1127,7 @@ interface StreamAttachment extends BaseAttachment {
 interface NewsStreamItem extends NewsItem {
     type: StreamItemTypes.News;
     contentsList: StreamPublishableItemContents[];
-    channelsList: string[];
+    channelsList: Channel[];
     isUnread: boolean;
     keywordsList?: Keyword[];
     knownNewsState?: StreamKnownNewsState[];
@@ -1139,7 +1139,7 @@ declare enum StreamKnownNewsState {
 interface EventStreamItem extends EventItem {
     type: StreamItemTypes.Event;
     contentsList: StreamPublishableItemContents[];
-    channelsList: string[];
+    channelsList: Channel[];
     isUnread: boolean;
     keywordsList?: Keyword[];
     userResponseType?: StreamEventResponse;
@@ -1148,7 +1148,7 @@ interface EventStreamItem extends EventItem {
 interface PageStreamItem extends PageItem {
     type: StreamItemTypes.Page;
     contentsList: StreamPublishableItemContents[];
-    channelsList: string[];
+    channelsList: Channel[];
     isUnread: boolean;
     keywordsList?: Keyword[];
     streamPageType?: string;
@@ -1207,7 +1207,14 @@ declare function usePostsStreamDataLoader(groupId?: string, filter?: PostStreamF
 declare function usePagesStreamDataLoader(filter?: PageFilterDefinition, searchText?: string): ItemLoader<PageStreamItem, number>;
 
 interface LibNewsFilterDefinition extends Omit<NewsFilterDefinition, 'channels' | 'keywords'> {
+    /**
+     * Limit results to those associated with the given channels.
+     * For better performance set channel IDs instead of names.
+     */
     channels?: string | FilterWithLogicalOperator;
+    /**
+     * Limit results to those associated with given keywords (keyword IDs)
+     */
     keywords?: string | FilterWithLogicalOperator;
 }
 
@@ -1220,8 +1227,8 @@ interface NewsListProps {
     searchText?: string;
     itemLayoutMode?: ItemLayoutMode;
     onItemClick?: (item: NewsItem, itemUrl?: string, isTitleClicked?: boolean) => unknown;
-    onChannelClick?: (channel: string) => unknown;
-    onKeywordClick?: (keyword: string) => unknown;
+    onChannelClick?: (channelName: string, channelItem?: Channel) => unknown;
+    onKeywordClick?: (keywordId: string, keywordItem?: Keyword) => unknown;
     hidePlaceholderIfNoBanner?: boolean;
     hidePagination?: boolean;
     pageSize?: number;
@@ -1238,6 +1245,9 @@ declare const ManageChannels: FC<ManageChannelsProps>;
 interface ChannelSelectorWrapperProps {
     onChannelsChanged: (channels: Channel[], logicalOperator?: LogicalOperator) => void;
     showLogicalOperatorOptions?: boolean;
+    /**
+     * For better performance set channel IDs instead of names.
+     */
     defaultSelectedChannels?: string[] | FilterWithLogicalOperator;
     className?: string;
 }
@@ -1254,8 +1264,8 @@ interface NewsGridProps {
     maxColumnCount?: number;
     rowCount?: number;
     onItemClick?: (item: NewsItem, itemUrl?: string, isTitleClicked?: boolean) => unknown;
-    onChannelClick?: (channel: string) => unknown;
-    onKeywordClick?: (keyword: string) => unknown;
+    onChannelClick?: (channelName: string, channelItem?: Channel) => unknown;
+    onKeywordClick?: (keywordId: string, keywordItem?: Keyword) => unknown;
     includeAllItems?: boolean;
     className?: string;
     hideIntro?: boolean;
@@ -1274,7 +1284,7 @@ interface EventGridProps {
     maxColumnCount?: number;
     rowCount?: number;
     onItemClick?: (item: EventItem, itemUrl?: string) => unknown;
-    onChannelClick?: (channel: string) => unknown;
+    onChannelClick?: (channelName: string, channelItem?: Channel) => unknown;
     className?: string;
 }
 declare const EventsGrid: FC<EventGridProps>;
@@ -1285,7 +1295,7 @@ interface EventsListProps {
     searchText?: string;
     itemLayoutMode?: ItemLayoutMode;
     onItemClick?: (item: EventItem, itemUrl?: string) => unknown;
-    onChannelClick?: (channel: string) => unknown;
+    onChannelClick?: (channelName: string, channelItem?: Channel) => unknown;
     hidePlaceholderIfNoBanner?: boolean;
     hidePagination?: boolean;
     pageSize?: number;
@@ -1294,7 +1304,14 @@ interface EventsListProps {
 declare const EventsList: FC<EventsListProps>;
 
 interface NewsHeroFilterProps {
+    /**
+     * Limit results to those associated with the given channels.
+     * For better performance set channel IDs instead of names.
+     */
     channels?: string | FilterWithLogicalOperator;
+    /**
+     * Limit results to those associated with given keywords (keyword IDs)
+     */
     keywords?: string | FilterWithLogicalOperator;
     pageSize?: number;
 }
@@ -1306,8 +1323,8 @@ interface NewsHeroProps {
     width?: number | string;
     height?: number | string;
     includeAllItems?: boolean;
-    onChannelClick?: (channel: string) => unknown;
-    onKeywordClick?: (keyword: string) => unknown;
+    onChannelClick?: (channelName: string, channelItem?: Channel) => unknown;
+    onKeywordClick?: (keywordId: string, keywordItem?: Keyword) => unknown;
     showKeywords?: boolean;
 }
 declare const NewsHero: FC<NewsHeroProps>;
@@ -1390,6 +1407,9 @@ interface FilterProps {
 declare const ToolbarFilterPanel: FC<FilterProps>;
 
 interface ChannelFilterProps {
+    /**
+     * For better performance set channel IDs instead of names.
+     */
     channels?: string[];
     className?: string;
 }
@@ -1538,7 +1558,7 @@ interface PagesGridProps {
     maxColumnCount?: number;
     rowCount?: number;
     onItemClick?: (item: PageItem, itemUrl?: string, isTitleClicked?: boolean) => unknown;
-    onKeywordClick?: (keyword: string) => unknown;
+    onKeywordClick?: (keywordId: string, keywordItem?: Keyword) => unknown;
     hideIntro?: boolean;
     className?: string;
 }
@@ -1549,7 +1569,7 @@ interface PagesListProps {
     searchText?: string;
     itemLayoutMode?: ItemLayoutMode;
     onItemClick?: (item: PageItem, itemUrl?: string, isTitleClicked?: boolean) => void;
-    onKeywordClick?: (keyword: string) => void;
+    onKeywordClick?: (keywordId: string, keywordItem?: Keyword) => void;
     hidePlaceholderIfNoBanner?: boolean;
     hidePagination?: boolean;
     pageSize?: number;

package/index.esm.js

@@ -1 +1 @@
-export{aL as AuthorFilter,aK as AuthorToolbarFilter,aa as Avatar,aD as ChannelFilter,aQ as ChannelSelector,aE as ChannelToolbarFilter,aH as ClearAllFiltersButton,b8 as ContactToolbarFilter,a_ as EditorToolbarIndicators,bo as ErrorType,bn as ErrorWrapper,b9 as EventDatesToolbarFilter,$ as EventDetail,av as EventDetailPreview,be as EventEditor,bf as EventEditorContextProvider,bg as EventEditorPanel,bi as EventEditorToolbarRecurringControls,bh as EventEditorToolbarStateActions,ao as EventItemContextProvider,ay as EventItemPreviewContextProvider,aP as EventView,ad as EventsEditorDashboard,a4 as EventsGrid,a5 as EventsList,aM as FilterSearch,b3 as GroupNotificationsSettings,a2 as ItemLayoutMode,aV as ItemResourceTypes,aY as KeywordPicker,aI as KeywordsFilter,aJ as KeywordsToolbarFilter,ba as LogicalOperator,a6 as ManageChannels,Y as NewsDetail,at as NewsDetailPreview,aR as NewsEditor,aS as NewsEditorContextProvider,ac as NewsEditorDashboard,aX as NewsEditorPanel,aW as NewsEditorToolbarStateActions,a3 as NewsGrid,ab as NewsHero,am as NewsItemContextProvider,aw as NewsItemPreviewContextProvider,a1 as NewsList,Z as PageDetail,au as PageDetailPreview,bk as PageEditor,bj as PageEditorContextProvider,bm as PageEditorPanel,bl as PageEditorToolbarStateActions,an as PageItemContextProvider,ax as PageItemPreviewContextProvider,bd as PageType,aT as PageViewTrackerSettingsContextProvider,bb as PagesGrid,bc as PagesList,a0 as PostDetail,b2 as PostGroupSelector,b5 as PostGroupSelectorButton,b1 as PostGroupsPicker,a$ as PostInputBox,b0 as PostList,W as PostListContextProvider,aG as PublishingDateFilter,aF as PublishingDateToolbarFilter,V as ReachContextProvider,aZ as ReachDialog,aU as TargetLinkOverrideContextProvider,ae as Toolbar,ah as ToolbarBookmarkButton,ai as ToolbarChannelSelector,al as ToolbarCloseButton,aO as ToolbarEventViewSelector,aA as ToolbarFilterModal,aB as ToolbarFilterModalButton,az as ToolbarFilterPanel,aN as ToolbarFilterSearch,b6 as ToolbarFilterToggleButton,af as ToolbarIconButton,ap as ToolbarLanguageSelector,aq as ToolbarManageButton,as as ToolbarManageItemButton,ar as ToolbarManageNewsItemButton,aj as ToolbarMarkAllEventsAsReadButton,ak as ToolbarMarkAllNewsAsReadButton,ap as ToolbarNewsLanguageSelector,b4 as ToolbarPostNotificationButton,ag as ToolbarUnreadItemsButton,a9 as UserDetails,aC as VerticalFilterPanel,b7 as isFilterActive,a7 as useCurrentUser,br as useEventsStreamDataLoader,a8 as useLazySubscriptionContext,bs as useNewsStreamDataLoader,bp as usePagesStreamDataLoader,bq as usePostsStreamDataLoader}from"./index.esm2.js";import"react/jsx-runtime";import"events";import"react";import"office-ui-fabric-react";import"react-router-dom";import"react-is";import"styled-components";import"react-dom";import"office-ui-fabric-core/dist/css/fabric.css";import"office-ui-fabric-react/lib/common/DirectionalHint";import"react-dom/server";
+export{aN as AuthorFilter,aM as AuthorToolbarFilter,ac as Avatar,aF as ChannelFilter,aS as ChannelSelector,aG as ChannelToolbarFilter,aJ as ClearAllFiltersButton,ba as ContactToolbarFilter,b0 as EditorToolbarIndicators,bq as ErrorType,bp as ErrorWrapper,bb as EventDatesToolbarFilter,a1 as EventDetail,ax as EventDetailPreview,bg as EventEditor,bh as EventEditorContextProvider,bi as EventEditorPanel,bk as EventEditorToolbarRecurringControls,bj as EventEditorToolbarStateActions,aq as EventItemContextProvider,aA as EventItemPreviewContextProvider,aR as EventView,af as EventsEditorDashboard,a6 as EventsGrid,a7 as EventsList,aO as FilterSearch,b5 as GroupNotificationsSettings,a4 as ItemLayoutMode,aX as ItemResourceTypes,a_ as KeywordPicker,aK as KeywordsFilter,aL as KeywordsToolbarFilter,bc as LogicalOperator,a8 as ManageChannels,$ as NewsDetail,av as NewsDetailPreview,aT as NewsEditor,aU as NewsEditorContextProvider,ae as NewsEditorDashboard,aZ as NewsEditorPanel,aY as NewsEditorToolbarStateActions,a5 as NewsGrid,ad as NewsHero,ao as NewsItemContextProvider,ay as NewsItemPreviewContextProvider,a3 as NewsList,a0 as PageDetail,aw as PageDetailPreview,bm as PageEditor,bl as PageEditorContextProvider,bo as PageEditorPanel,bn as PageEditorToolbarStateActions,ap as PageItemContextProvider,az as PageItemPreviewContextProvider,bf as PageType,aV as PageViewTrackerSettingsContextProvider,bd as PagesGrid,be as PagesList,a2 as PostDetail,b4 as PostGroupSelector,b7 as PostGroupSelectorButton,b3 as PostGroupsPicker,b1 as PostInputBox,b2 as PostList,Z as PostListContextProvider,aI as PublishingDateFilter,aH as PublishingDateToolbarFilter,Y as ReachContextProvider,a$ as ReachDialog,aW as TargetLinkOverrideContextProvider,ag as Toolbar,aj as ToolbarBookmarkButton,ak as ToolbarChannelSelector,an as ToolbarCloseButton,aQ as ToolbarEventViewSelector,aC as ToolbarFilterModal,aD as ToolbarFilterModalButton,aB as ToolbarFilterPanel,aP as ToolbarFilterSearch,b8 as ToolbarFilterToggleButton,ah as ToolbarIconButton,ar as ToolbarLanguageSelector,as as ToolbarManageButton,au as ToolbarManageItemButton,at as ToolbarManageNewsItemButton,al as ToolbarMarkAllEventsAsReadButton,am as ToolbarMarkAllNewsAsReadButton,ar as ToolbarNewsLanguageSelector,b6 as ToolbarPostNotificationButton,ai as ToolbarUnreadItemsButton,ab as UserDetails,aE as VerticalFilterPanel,b9 as isFilterActive,a9 as useCurrentUser,bt as useEventsStreamDataLoader,aa as useLazySubscriptionContext,bu as useNewsStreamDataLoader,br as usePagesStreamDataLoader,bs as usePostsStreamDataLoader}from"./index.esm2.js";import"react/jsx-runtime";import"events";import"react";import"office-ui-fabric-react";import"react-router-dom";import"react-is";import"styled-components";import"react-dom";import"office-ui-fabric-core/dist/css/fabric.css";import"office-ui-fabric-react/lib/common/DirectionalHint";import"react-dom/server";