@livetiles/reach-components-react 0.5.0-preview.731 → 0.5.0-preview.733

package/ChannelFilter.d.ts

@@ -1,5 +1,8 @@
 import { FC } from 'react';
 export interface ChannelFilterProps {
+    /**
+     * For better performance set channel IDs instead of names.
+     */
     channels?: string[];
     className?: string;
 }

package/ChannelSelectorWrapper.d.ts

@@ -4,6 +4,9 @@ import { Channel } from '@livetiles/reach/util/common';
 export interface ChannelSelectorWrapperProps {
     onChannelsChanged: (channels: Channel[], logicalOperator?: LogicalOperator) => void;
     showLogicalOperatorOptions?: boolean;
+    /**
+     * For better performance set channel IDs instead of names.
+     */
     defaultSelectedChannels?: string[] | FilterWithLogicalOperator;
     className?: string;
 }

package/EventDetail.d.ts

@@ -1,16 +1,17 @@
 import { FC } from 'react';
+import { Channel, Keyword } from '@livetiles/reach/util/common';
 export interface EventDetailProps {
     itemId?: string;
     hideComments?: boolean;
     hideLikes?: boolean;
-    onChannelClick?: (channel: string) => unknown;
-    onKeywordClick?: (keyword: string) => unknown;
+    onChannelClick?: (channelName: string, channelItem?: Channel) => unknown;
+    onKeywordClick?: (keywordId: string, keywordItem?: Keyword) => unknown;
     className?: string;
 }
 export declare const EventDetail: FC<EventDetailProps>;
 export declare const EventDetailMainContent: FC<{
     hideComments?: boolean;
     hideLikes?: boolean;
-    onChannelClick?: (channel: string) => unknown;
-    onKeywordClick?: (keyword: string) => unknown;
+    onChannelClick?: (channelName: string, channelItem?: Channel) => unknown;
+    onKeywordClick?: (keywordId: string, keywordItem?: Keyword) => unknown;
 }>;

package/EventsGrid.d.ts

@@ -1,5 +1,5 @@
 import { FC } from 'react';
-import { EventItem } from '@livetiles/reach/util/common';
+import { Channel, EventItem } from '@livetiles/reach/util/common';
 import { EventFilterDefinition } from '@livetiles/reach/feature/content';
 import { EventView } from '@livetiles/reach/ui/common';
 export interface EventGridProps {
@@ -14,7 +14,7 @@ export interface EventGridProps {
     maxColumnCount?: number;
     rowCount?: number;
     onItemClick?: (item: EventItem, itemUrl?: string) => unknown;
-    onChannelClick?: (channel: string) => unknown;
+    onChannelClick?: (channelName: string, channelItem?: Channel) => unknown;
     className?: string;
 }
 export declare const EventsGrid: FC<EventGridProps>;

package/EventsList.d.ts

@@ -1,5 +1,5 @@
 import { FC } from 'react';
-import { EventItem } from '@livetiles/reach/util/common';
+import { Channel, EventItem } from '@livetiles/reach/util/common';
 import { EventFilterDefinition } from '@livetiles/reach/feature/content';
 import { ItemLayoutMode } from './NewsList';
 import { EventView } from '@livetiles/reach/ui/common';
@@ -9,7 +9,7 @@ export 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;

package/NewsDetail.d.ts

@@ -1,17 +1,18 @@
 import { FC } from 'react';
+import { Channel, Keyword } from '@livetiles/reach/util/common';
 export interface NewsDetailProps {
     itemId?: string;
     hideComments?: boolean;
     hideLikes?: boolean;
     preventExternalContentAutoRedirect?: boolean;
-    onChannelClick?: (channel: string) => unknown;
-    onKeywordClick?: (keyword: string) => unknown;
+    onChannelClick?: (channelName: string, channelItem?: Channel) => unknown;
+    onKeywordClick?: (keywordId: string, keywordItem?: Keyword) => unknown;
     className?: string;
 }
 export declare const NewsDetail: FC<NewsDetailProps>;
 export declare const NewsDetailMainContent: FC<{
     hideComments?: boolean;
     hideLikes?: boolean;
-    onChannelClick?: (channel: string) => unknown;
-    onKeywordClick?: (keyword: string) => unknown;
+    onChannelClick?: (channelName: string, channelItem?: Channel) => unknown;
+    onKeywordClick?: (keywordId: string, keywordItem?: Keyword) => unknown;
 }>;

package/NewsDetailViewMetaInfo.d.ts

@@ -1,4 +1,5 @@
 import { FC } from 'react';
+import { Channel } from '@livetiles/reach/util/common';
 export declare const NewsDetailViewMetaInfo: FC<{
-    onChannelClick?: (channel: string) => unknown;
+    onChannelClick?: (channelName: string, channelItem?: Channel) => unknown;
 }>;

package/NewsGrid.d.ts

@@ -1,5 +1,5 @@
 import { FC } from 'react';
-import { NewsItem } from '@livetiles/reach/util/common';
+import { Channel, Keyword, NewsItem } from '@livetiles/reach/util/common';
 import { LibNewsFilterDefinition } from './common/filter/LibNewsFilterDefinition';
 export interface NewsGridProps {
     filter?: LibNewsFilterDefinition;
@@ -12,8 +12,8 @@ export 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;

package/NewsGridCard.d.ts

@@ -1,5 +1,5 @@
 import { FC, MouseEvent } from 'react';
-import { Channel, NewsItem } from '@livetiles/reach/util/common';
+import { Channel, Keyword, NewsItem } from '@livetiles/reach/util/common';
 export interface NewsGridCardProps {
     item: NewsItem;
     baseRoute?: string;
@@ -7,7 +7,7 @@ export interface NewsGridCardProps {
     onCardClick?: (event: MouseEvent<unknown>) => unknown;
     onTitleClick?: (event: MouseEvent<unknown>) => unknown;
     onChannelClick?: (channel: Channel) => unknown;
-    onKeywordClick?: (keyword: string) => unknown;
+    onKeywordClick?: (keywordId: string, keywordItem?: Keyword) => unknown;
     className?: string;
     hideIntro?: boolean;
 }

package/NewsHero.d.ts

@@ -1,8 +1,15 @@
 import { FC } from 'react';
 import { FilterWithLogicalOperator } from '@livetiles/reach/feature/content';
-import { NewsItem } from '@livetiles/reach/util/common';
+import { Channel, Keyword, NewsItem } from '@livetiles/reach/util/common';
 export 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;
 }
@@ -14,8 +21,8 @@ export 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;
 }
 export declare const NewsHero: FC<NewsHeroProps>;

package/NewsList.d.ts

@@ -1,5 +1,5 @@
 import { FC } from 'react';
-import { NewsItem } from '@livetiles/reach/util/common';
+import { Channel, Keyword, NewsItem } from '@livetiles/reach/util/common';
 import { LibNewsFilterDefinition } from './common/filter/LibNewsFilterDefinition';
 export declare enum ItemLayoutMode {
     Default = "default",
@@ -10,8 +10,8 @@ export 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;

package/PageDetail.d.ts

@@ -1,11 +1,12 @@
 import { FC } from 'react';
+import { Keyword } from '@livetiles/reach/util/common';
 export interface PageDetailProps {
     itemId?: string;
     hideComments?: boolean;
     hideLikes?: boolean;
     preventExternalContentAutoRedirect?: boolean;
     homeBreadcrumbTargetUrl?: string;
-    onKeywordClick?: (keyword: string) => unknown;
+    onKeywordClick?: (keywordId: string, keywordItem?: Keyword) => unknown;
     className?: string;
 }
 export declare const PageDetail: FC<PageDetailProps>;
@@ -13,6 +14,6 @@ export declare const PageDetailMainContent: FC<{
     hideComments?: boolean;
     hideLikes?: boolean;
     homeBreadcrumbTargetUrl?: string;
-    onKeywordClick?: (keyword: string) => unknown;
+    onKeywordClick?: (keywordId: string, keywordItem?: Keyword) => unknown;
 }>;
 export declare const PageHeader: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {}, never>;

package/PageGridCard.d.ts

@@ -1,12 +1,12 @@
 import { FC } from 'react';
-import { PageItem } from '@livetiles/reach/util/common';
+import { Keyword, PageItem } from '@livetiles/reach/util/common';
 export interface PageGridCardProps {
     item: PageItem;
     baseRoute?: string;
     openTargetInNewWindow?: boolean;
     onCardClick?: (event: React.MouseEvent<unknown>) => unknown;
     onTitleClick?: (event: React.MouseEvent<unknown>) => unknown;
-    onKeywordClick?: (keyword: string) => unknown;
+    onKeywordClick?: (keywordId: string, keywordItem?: Keyword) => unknown;
     hideIntro?: boolean;
     className?: string;
 }

package/PagesGrid.d.ts

@@ -1,5 +1,5 @@
 import { FC } from 'react';
-import { PageItem } from '@livetiles/reach/util/common';
+import { Keyword, PageItem } from '@livetiles/reach/util/common';
 import { PageFilterDefinition } from '@livetiles/reach/feature/content';
 export interface PagesGridProps {
     filter?: PageFilterDefinition;
@@ -8,7 +8,7 @@ export 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;
 }

package/PagesList.d.ts

@@ -1,5 +1,5 @@
 import { FC } from 'react';
-import { PageItem } from '@livetiles/reach/util/common';
+import { Keyword, PageItem } from '@livetiles/reach/util/common';
 import { PageFilterDefinition } from '@livetiles/reach/feature/content';
 import { ItemLayoutMode } from './NewsList';
 export interface PagesListProps {
@@ -7,7 +7,7 @@ export 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/common/filter/LibNewsFilterDefinition.d.ts

@@ -1,5 +1,12 @@
 import { FilterWithLogicalOperator, NewsFilterDefinition } from '@livetiles/reach/feature/content';
 export 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;
 }

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,31 @@ 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;
+    };
+}
+
 interface DirectoryConfiguration extends DirectoryConfigurationPatch {
     domains?: string[];
     tenantId: string;
@@ -416,23 +400,6 @@ declare enum FieldMode {
     Hidden = 3
 }
 
-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;
@@ -464,14 +431,6 @@ declare enum KnownNewsState {
     Alert = 2
 }
 
-interface Channel {
-    id: string;
-    name: string;
-    translations?: {
-        [key: string]: string;
-    };
-}
-
 declare type VersionId = string;
 interface SchedulableItem extends PublishableItem {
     metadata?: NewsMetadata;
@@ -873,6 +832,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 LegacyDialog: FC<IDialogProps>;
 
 interface ToolbarProps {
@@ -1139,7 +1139,7 @@ interface StreamAttachment extends BaseAttachment {
 interface NewsStreamItem extends NewsItem {
     type: StreamItemTypes.News;
     contentsList: StreamPublishableItemContents[];
-    channelsList: string[];
+    channelsList: Channel[];
     isUnread: boolean;
     keywordsList?: Keyword[];
     knownNewsState?: StreamKnownNewsState[];
@@ -1151,7 +1151,7 @@ declare enum StreamKnownNewsState {
 interface EventStreamItem extends EventItem {
     type: StreamItemTypes.Event;
     contentsList: StreamPublishableItemContents[];
-    channelsList: string[];
+    channelsList: Channel[];
     isUnread: boolean;
     keywordsList?: Keyword[];
     userResponseType?: StreamEventResponse;
@@ -1160,7 +1160,7 @@ interface EventStreamItem extends EventItem {
 interface PageStreamItem extends PageItem {
     type: StreamItemTypes.Page;
     contentsList: StreamPublishableItemContents[];
-    channelsList: string[];
+    channelsList: Channel[];
     isUnread: boolean;
     keywordsList?: Keyword[];
     streamPageType?: string;
@@ -1219,7 +1219,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;
 }
 
@@ -1232,8 +1239,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;
@@ -1250,6 +1257,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;
 }
@@ -1266,8 +1276,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;
@@ -1286,7 +1296,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>;
@@ -1297,7 +1307,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;
@@ -1306,7 +1316,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;
 }
@@ -1318,8 +1335,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>;
@@ -1402,6 +1419,9 @@ interface FilterProps {
 declare const ToolbarFilterPanel: FC<FilterProps>;
 
 interface ChannelFilterProps {
+    /**
+     * For better performance set channel IDs instead of names.
+     */
     channels?: string[];
     className?: string;
 }
@@ -1550,7 +1570,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;
 }
@@ -1561,7 +1581,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;