@livetiles/reach-components-react 0.4.0-preview.234 → 0.4.0-preview.238

package/NewsGrid.d.ts

@@ -1,8 +1,8 @@
 import { FC } from 'react';
-import { NewsFilterDefinition } from '@livetiles/reach/feature/content';
 import { NewsItem } from '@livetiles/reach/util/common';
+import { LibNewsFilterDefinition } from './common/filter/LibNewsFilterDefinition';
 export interface NewsGridProps {
-    filter?: NewsFilterDefinition;
+    filter?: LibNewsFilterDefinition;
     hidePagination?: boolean;
     columnCount?: number;
     rowCount?: number;

package/NewsHero.d.ts

@@ -1,8 +1,9 @@
 import { FC } from 'react';
+import { FilterWithLogicalOperator } from '@livetiles/reach/feature/content';
 import { NewsItem } from '@livetiles/reach/util/common';
 export interface NewsHeroFilterProps {
-    channels?: string[];
-    keywords?: string[];
+    channels?: string | FilterWithLogicalOperator;
+    keywords?: string | string[];
     pageSize?: number;
 }
 export interface NewsHeroProps {

package/NewsList.d.ts

@@ -1,12 +1,12 @@
 import { FC } from 'react';
 import { NewsItem } from '@livetiles/reach/util/common';
-import { NewsFilterDefinition } from '@livetiles/reach/feature/content';
+import { LibNewsFilterDefinition } from './common/filter/LibNewsFilterDefinition';
 export declare enum ItemLayoutMode {
     Default = "default",
     Compact = "compact"
 }
 export interface NewsListProps {
-    filter?: NewsFilterDefinition;
+    filter?: LibNewsFilterDefinition;
     itemLayoutMode?: ItemLayoutMode;
     onItemClick?: (item: NewsItem, itemUrl?: string, isTitleClicked?: boolean) => unknown;
     hidePlaceholderIfNoBanner?: boolean;

package/common/filter/LibNewsFilterDefinition.d.ts

@@ -0,0 +1,5 @@
+import { FilterWithLogicalOperator, NewsFilterDefinition } from '@livetiles/reach/feature/content';
+export interface LibNewsFilterDefinition extends Omit<NewsFilterDefinition, 'channels' | 'keywords'> {
+    channels?: string | FilterWithLogicalOperator;
+    keywords?: string | string[];
+}

package/common/utils.d.ts

@@ -1,7 +1,8 @@
 import { NewsItem } from '@livetiles/reach/util/common';
 import { NewsFilterDefinition } from '@livetiles/reach/feature/content';
+import { LibNewsFilterDefinition } from './filter/LibNewsFilterDefinition';
 export declare function useNewsItemClickHandler(): (e: React.MouseEvent<unknown>, item: NewsItem, shouldHandleExternalContent: boolean, onItemClick?: (item: NewsItem, itemUrl?: string) => unknown, newTab?: boolean) => void;
-export declare function useNewsLoaderWithFiltersAndPagination(pageSize: number, filter?: NewsFilterDefinition): {
+export declare function useNewsLoaderWithFiltersAndPagination(pageSize: number, filter?: LibNewsFilterDefinition): {
     items: any[];
     isInitialLoading: boolean;
     isLoadingNextPage: boolean;

package/index.d.ts

@@ -646,6 +646,10 @@ interface BaseFilterDefinition {
 interface IndexableFilterDefinition {
     [key: string]: any;
 }
+interface FilterWithLogicalOperator {
+    items?: string[];
+    operator?: LogicalOperator;
+}
 declare enum LogicalOperator {
     Or = "or",
     And = "and"
@@ -655,15 +659,12 @@ interface AuthorFilterDefinition extends IndexableFilterDefinition {
     author?: string;
 }
 
-interface StateFilterDefinition extends IndexableFilterDefinition {
-    state?: WorkflowStatus;
+interface ChannelsFilterDefinition extends IndexableFilterDefinition {
+    channels?: FilterWithLogicalOperator;
 }
 
-interface ChannelsFilterDefinition extends IndexableFilterDefinition {
-    channels?: {
-        items?: string[];
-        operator?: LogicalOperator;
-    };
+interface StateFilterDefinition extends IndexableFilterDefinition {
+    state?: WorkflowStatus;
 }
 
 interface NewsFilterDefinition extends PublishableItemFilterDefinition, AuthorFilterDefinition, ChannelsFilterDefinition, StateFilterDefinition {
@@ -672,12 +673,17 @@ interface NewsFilterDefinition extends PublishableItemFilterDefinition, AuthorFi
     unreadOnly?: boolean;
 }
 
+interface LibNewsFilterDefinition extends Omit<NewsFilterDefinition, 'channels' | 'keywords'> {
+    channels?: string | FilterWithLogicalOperator;
+    keywords?: string | string[];
+}
+
 declare enum ItemLayoutMode {
     Default = "default",
     Compact = "compact"
 }
 interface NewsListProps {
-    filter?: NewsFilterDefinition;
+    filter?: LibNewsFilterDefinition;
     itemLayoutMode?: ItemLayoutMode;
     onItemClick?: (item: NewsItem, itemUrl?: string, isTitleClicked?: boolean) => unknown;
     hidePlaceholderIfNoBanner?: boolean;
@@ -693,7 +699,7 @@ interface ManageChannelsProps {
 declare const ManageChannels: FC<ManageChannelsProps>;
 
 interface NewsGridProps {
-    filter?: NewsFilterDefinition;
+    filter?: LibNewsFilterDefinition;
     hidePagination?: boolean;
     columnCount?: number;
     rowCount?: number;
@@ -703,8 +709,8 @@ interface NewsGridProps {
 declare const NewsGrid: FC<NewsGridProps>;
 
 interface NewsHeroFilterProps {
-    channels?: string[];
-    keywords?: string[];
+    channels?: string | FilterWithLogicalOperator;
+    keywords?: string | string[];
     pageSize?: number;
 }
 interface NewsHeroProps {
@@ -774,4 +780,4 @@ declare const KeywordsFilter: FC;
 
 declare const AuthorFilter: FC;
 
-export { AuthorFilter, Avatar, Props as AvatarProps, ChannelFilter, ChannelFilterProps, ClearAllFiltersButton, ClearAllFiltersButtonProps, EventDetail, EventDetailProps, FilterProps, ItemLayoutMode, KeywordsFilter, ManageChannels, ManageChannelsProps, NewsDetail, NewsDetailPreview, NewsDetailPreviewProps, NewsDetailProps, NewsEditorDashboard, NewsEditorDashboardProps, NewsGrid, NewsGridProps, NewsHero, NewsHeroProps, NewsItemContextProvider, NewsItemPreviewContextProvider, NewsList, NewsListProps, PageDetail, PageDetailProps, PublishableItem, PublishingDateFilter, ReachContextProps, ReachContextProvider, Toolbar, ToolbarChannelSelector, ToolbarChannelSelectorOption, ToolbarChannelSelectorProps, ToolbarCloseButton, ToolbarCloseButtonProps, ToolbarFilterPanel, ToolbarIconButton, ToolbarIconButtonProps, ToolbarManageNewsItemButton, ToolbarMarkAllEventsAsReadButton, ToolbarMarkAllItemsAsReadButtonProps, ToolbarMarkAllNewsAsReadButton, ToolbarNewsLanguageSelector, ToolbarProps, ToolbarSearchProps, UserDetails, UserDetailsProps, useCurrentUser };
+export { AuthorFilter, Avatar, Props as AvatarProps, ChannelFilter, ChannelFilterProps, ClearAllFiltersButton, ClearAllFiltersButtonProps, EventDetail, EventDetailProps, FilterProps, ItemLayoutMode, KeywordsFilter, LibNewsFilterDefinition, ManageChannels, ManageChannelsProps, NewsDetail, NewsDetailPreview, NewsDetailPreviewProps, NewsDetailProps, NewsEditorDashboard, NewsEditorDashboardProps, NewsGrid, NewsGridProps, NewsHero, NewsHeroProps, NewsItemContextProvider, NewsItemPreviewContextProvider, NewsList, NewsListProps, PageDetail, PageDetailProps, PublishableItem, PublishingDateFilter, ReachContextProps, ReachContextProvider, Toolbar, ToolbarChannelSelector, ToolbarChannelSelectorOption, ToolbarChannelSelectorProps, ToolbarCloseButton, ToolbarCloseButtonProps, ToolbarFilterPanel, ToolbarIconButton, ToolbarIconButtonProps, ToolbarManageNewsItemButton, ToolbarMarkAllEventsAsReadButton, ToolbarMarkAllItemsAsReadButtonProps, ToolbarMarkAllNewsAsReadButton, ToolbarNewsLanguageSelector, ToolbarProps, ToolbarSearchProps, UserDetails, UserDetailsProps, useCurrentUser };