@livetiles/reach-plugin-types 0.5.0-preview.639 → 0.5.0-preview.641

package/lib/index.d.ts

@@ -1367,6 +1367,33 @@ declare module "libs/reach/util/common/src/content/Language" {
         code: string;
     }
 }
+declare module "libs/reach/util/common/src/content/KeywordGroup" {
+    export interface KeywordGroup {
+        id: string;
+        name: string;
+        keywords: Keyword[];
+        translations: {
+            [key: string]: string;
+        };
+    }
+    export interface Keyword {
+        id: string;
+        name: string;
+        groupId?: string;
+        translations: {
+            [key: string]: string;
+        };
+    }
+}
+declare module "libs/reach/util/common/src/channels/Channel" {
+    export interface Channel {
+        id: string;
+        name: string;
+        translations?: {
+            [key: string]: string;
+        };
+    }
+}
 declare module "libs/reach/util/common/src/user/Subscription" {
     import { Resources } from "libs/reach/util/context/src/index";
     import { Account } from "libs/reach/util/common/src/user/Account";
@@ -1374,6 +1401,8 @@ declare module "libs/reach/util/common/src/user/Subscription" {
     import { CurrentUser, NotificationType } from "libs/reach/util/common/src/user/User";
     import { IdentityProviderNames, IdentityProviderSettings, SubscriptionInfo as BaseSubscriptionInfo } from "libs/shared/util/authentication/src/index";
     import { Language, LanguageBase } from "libs/reach/util/common/src/content/Language";
+    import { Keyword, KeywordGroup } from "libs/reach/util/common/src/content/KeywordGroup";
+    import { Channel } from "libs/reach/util/common/src/channels/Channel";
     export interface DirectoryConfiguration extends DirectoryConfigurationPatch {
         domains?: string[];
         tenantId: string;
@@ -1434,6 +1463,11 @@ declare module "libs/reach/util/common/src/user/Subscription" {
         termsAndConditionsHash?: string;
         logoInfo: LogoInfo;
     }
+    export interface EssentialSubscriptionData {
+        channels: Channel[];
+        keywords: Keyword[];
+        keywordGroups: KeywordGroup[];
+    }
     export enum LogoSize {
         large = "large",
         small = "small"
@@ -1933,24 +1967,6 @@ declare module "libs/reach/util/common/src/user/RequestUserInformation" {
         organization: Organization;
     }
 }
-declare module "libs/reach/util/common/src/content/KeywordGroup" {
-    export interface KeywordGroup {
-        id: string;
-        name: string;
-        keywords: Keyword[];
-        translations: {
-            [key: string]: string;
-        };
-    }
-    export interface Keyword {
-        id: string;
-        name: string;
-        groupId?: string;
-        translations: {
-            [key: string]: string;
-        };
-    }
-}
 declare module "libs/reach/util/common/src/content/ItemStatistics" {
     export interface ItemStatistics {
         commentCount?: number;
@@ -1989,15 +2005,6 @@ declare module "libs/reach/util/common/src/content/KnownNewsState" {
         Alert = 2
     }
 }
-declare module "libs/reach/util/common/src/channels/Channel" {
-    export interface Channel {
-        id: string;
-        name: string;
-        translations?: {
-            [key: string]: string;
-        };
-    }
-}
 declare module "libs/reach/util/common/src/content/NewsItem" {
     import { NewsMetadata } from "libs/reach/util/common/src/content/NewsMetadata";
     import { KnownNewsState } from "libs/reach/util/common/src/content/KnownNewsState";
@@ -3643,14 +3650,7 @@ declare module "libs/reach/util/common/src/notification/index" {
     export * from "libs/reach/util/common/src/notification/NotificationContext";
     export * from "libs/reach/util/common/src/notification/ToastNotificationHost";
 }
-declare module "libs/reach/util/common/src/keywords/useCachedKeywordsApi" {
-    export function useCachedKeywordsApi(): {
-        getAllKeywords: (subscriptionId: string, force?: boolean) => Promise<import("@livetiles/reach/util/common").Keyword[]>;
-        getSelectedGroups: (subscriptionId: string) => Promise<import("@livetiles/reach/util/common").KeywordGroup[]>;
-    };
-}
 declare module "libs/reach/util/common/src/keywords/index" {
-    export * from "libs/reach/util/common/src/keywords/useCachedKeywordsApi";
     export * from "libs/reach/util/common/src/keywords/useKeywordsApi";
 }
 declare module "libs/reach/util/common/src/channels/useChannelsApi" {
@@ -3660,13 +3660,7 @@ declare module "libs/reach/util/common/src/channels/useChannelsApi" {
         getChannelsByItemId: (id: string, route?: string) => Promise<Channel[]>;
     };
 }
-declare module "libs/reach/util/common/src/channels/useCachedChannelsApi" {
-    export function useCachedChannelsApi(): {
-        getChannels: (subscriptionId: string) => Promise<import("@livetiles/reach/util/common").Channel[]>;
-    };
-}
 declare module "libs/reach/util/common/src/channels/index" {
-    export * from "libs/reach/util/common/src/channels/useCachedChannelsApi";
     export * from "libs/reach/util/common/src/channels/useChannelsApi";
     export * from "libs/reach/util/common/src/channels/Channel";
 }
@@ -3676,11 +3670,25 @@ declare module "libs/reach/util/common/src/subscription/EnforcedSubscriptionCont
         loadingIndicator?: ReactNode;
     }>;
 }
+declare module "libs/reach/util/common/src/subscription/useSubscriptionApi" {
+    import { EssentialSubscriptionData, SubscriptionInfo, TermsAndConditions } from "libs/reach/util/common/src/user/Subscription";
+    export function useSubscriptionApi(): {
+        getSubscriptionBySubscriptionIdentifier: (subscriptionIdentifier: string) => Promise<SubscriptionInfo>;
+        getTermsAndConditions: () => Promise<TermsAndConditions>;
+        getEssentialSubscriptionData: () => Promise<EssentialSubscriptionData>;
+    };
+}
+declare module "libs/reach/util/common/src/subscription/useCachedEssentialSubscriptionData" {
+    export function useCachedEssentialSubscriptionData(): {
+        getCachedEssentialSubscriptionData: (subscriptionId: string) => Promise<import("@livetiles/reach/util/common").EssentialSubscriptionData>;
+    };
+}
 declare module "libs/reach/util/common/src/subscription/SubscriptionContext" {
     import { FC } from 'react';
     import { Keyword, KeywordGroup } from "libs/reach/util/common/src/content/KeywordGroup";
     import { Channel } from "libs/reach/util/common/src/channels/Channel";
     import { KeywordsByGroupId } from "libs/reach/util/common/src/keywords/useKeywordsApi";
+    import { EssentialSubscriptionData } from "libs/reach/util/common/src/user/Subscription";
     interface SubscriptionData {
         channels?: Channel[];
         allKeywords?: Keyword[];
@@ -3698,18 +3706,9 @@ declare module "libs/reach/util/common/src/subscription/SubscriptionContext" {
     export const LazySubscriptionContextProvider: FC;
     export const LazyCachedSubscriptionContextProvider: FC;
     export const LazySubscriptionContextProviderBase: FC<{
-        getChannels: (subscriptionId: string) => Promise<Channel[]>;
-        getAllKeywords: (subscriptionId: string, force?: boolean) => Promise<Keyword[]>;
-        getSelectedGroups: (subscriptionId: string) => Promise<KeywordGroup[]>;
+        getEssentialSubscriptionData: (subscriptionId: string) => Promise<EssentialSubscriptionData>;
     }>;
 }
-declare module "libs/reach/util/common/src/subscription/useSubscriptionApi" {
-    import { SubscriptionInfo, TermsAndConditions } from "libs/reach/util/common/src/user/Subscription";
-    export function useSubscriptionApi(): {
-        getSubscriptionBySubscriptionIdentifier: (subscriptionIdentifier: string) => Promise<SubscriptionInfo>;
-        getTermsAndConditions: () => Promise<TermsAndConditions>;
-    };
-}
 declare module "libs/reach/util/common/src/subscription/useLazySubscriptionContext" {
     export function useLazySubscriptionContext(): import("libs/reach/util/common/src/subscription/SubscriptionContext").LazySubscriptionContextType;
 }
@@ -4534,10 +4533,9 @@ declare module "libs/reach/ui/common/src/common/KeywordTitle" {
         groupName?: string;
         groupId?: string;
         keywordName?: string;
-        keywordId?: string;
         language?: string;
         underlined?: boolean;
-        onClick?: (keyword: string) => unknown;
+        onClick?: () => unknown;
         tabIndex?: number;
     }
     export const KeywordTitle: FC<Props>;
@@ -4934,7 +4932,7 @@ declare module "libs/reach/ui/common/src/common/channels/ClickableChannelTitles"
         buildChannelFilterUrl?: (channelName: string) => string;
         language?: string;
         channelBackgroundColor?: string;
-        onClick?: (channel: string) => unknown;
+        onClick?: (channelName: string, channelItem?: Channel) => unknown;
         className?: string;
     }>;
 }
@@ -6277,8 +6275,8 @@ declare module "libs/reach/feature/content/src/filter/ItemTypeFilterDefinition"
 }
 declare module "libs/reach/feature/content/src/filter/useFilter" {
     import { FC } from 'react';
-    import { IndexableFilterDefinition } from "libs/reach/feature/content/src/filter/BaseFilterDefinition";
     import { CurrentUser } from "libs/reach/util/common/src/index";
+    import { IndexableFilterDefinition } from "libs/reach/feature/content/src/filter/BaseFilterDefinition";
     export interface InjectedFilterProps {
         filter: IndexableFilterDefinition;
         hasFilter: boolean;
@@ -6295,7 +6293,9 @@ declare module "libs/reach/feature/content/src/filter/useFilter" {
         onSearchChange: (search: string) => void;
         onClearFilter: () => void;
     };
-    export const FilterContext: import("react").Context<InjectedFilterProps>;
+    export const FilterContext: import("react").Context<InjectedFilterProps & {
+        hasFilterOnPageLoad: boolean;
+    }>;
     export const FilterContextProvider: FC<{
         addFilters?: (locationParams: {
             [paramName: string]: any;
@@ -6834,7 +6834,7 @@ declare module "libs/reach/feature/content/src/common/keywords/KeywordsInfo" {
         };
         language?: string;
         filterBaseUrl?: string;
-        onKeywordClick?: (keywordId: string) => void;
+        onKeywordClick?: (keywordId: string, keyword?: Keyword) => void;
         className?: string;
     }
     export const KeywordsInfo: FC<KeywordsInfoProps>;
@@ -6846,7 +6846,7 @@ declare module "libs/reach/feature/content/src/common/keywords/KeywordsInfo" {
         };
         language?: string;
         filterBaseUrl?: string;
-        onKeywordClick?: (keywordId: string) => void;
+        onKeywordClick?: (keywordId: string, keyword?: Keyword) => void;
         className?: string;
     }>;
     export const FlatKeywords: FC<{
@@ -6854,7 +6854,7 @@ declare module "libs/reach/feature/content/src/common/keywords/KeywordsInfo" {
         filterBaseUrl?: string;
         className?: string;
         useGridKeywordTitle?: boolean;
-        onClick?: (keyword: string) => unknown;
+        onClick?: (keywordId: string, keywordItem?: Keyword) => unknown;
         showAllKeywordsInCallout?: boolean;
     }>;
 }
@@ -6915,7 +6915,7 @@ declare module "libs/reach/feature/content/src/common/detail/events/EventPathCon
 }
 declare module "libs/reach/feature/content/src/common/detail/events/controls/EventMetaInfo" {
     import { FC } from 'react';
-    import { EventItem, EventLocation } from "libs/reach/util/common/src/index";
+    import { Channel, EventItem, EventLocation } from "libs/reach/util/common/src/index";
     export const EventLocationInfo: FC<{
         locations: EventLocation[];
         itemId: string;
@@ -6934,7 +6934,7 @@ declare module "libs/reach/feature/content/src/common/detail/events/controls/Eve
         className?: string;
         allowFilterByChannels?: boolean;
         channelBackgroundColor?: string;
-        onChannelClick?: (channel: string) => unknown;
+        onChannelClick?: (channelName: string, channelItem?: Channel) => unknown;
     }>;
     export const RTLMetaInfoStyles: import("styled-components").FlattenSimpleInterpolation;
 }
@@ -7461,7 +7461,7 @@ declare module "libs/reach/feature/content/src/common/TargetLinkOverrideContext"
 }
 declare module "libs/reach/feature/content/src/common/item-tile/NewsItemTile" {
     import { FC, ReactNode } from 'react';
-    import { NewsItem } from "libs/reach/util/common/src/index";
+    import { Channel, Keyword, NewsItem } from "libs/reach/util/common/src/index";
     export enum ItemTileLayoutMode {
         BannerTopMode = "bannerTop",
         BannerLeftMode = "bannerLeft"
@@ -7484,8 +7484,8 @@ declare module "libs/reach/feature/content/src/common/item-tile/NewsItemTile" {
         buttons?: ReactNode;
         openTargetInNewWindow?: boolean;
         onClick?: (event: React.MouseEvent<unknown>, isTitleClicked?: boolean) => unknown;
-        onChannelClick?: (channel: string) => unknown;
-        onKeywordClick?: (keyword: string) => unknown;
+        onChannelClick?: (channelName: string, channelItem?: Channel) => unknown;
+        onKeywordClick?: (keywordId: string, keywordItem?: Keyword) => unknown;
         styleDefinition?: StyleDefinition;
         readOnly?: boolean;
         enableModalRouting?: boolean;
@@ -7627,7 +7627,7 @@ declare module "libs/reach/feature/content/src/common/breadcrumb/ListItemBreadcr
 }
 declare module "libs/reach/feature/content/src/common/item-tile/PageItemTile" {
     import { FC, ReactNode } from 'react';
-    import { PageItem } from "libs/reach/util/common/src/index";
+    import { Keyword, PageItem } from "libs/reach/util/common/src/index";
     import { ItemTileLayoutMode } from "libs/reach/feature/content/src/index";
     interface StyleDefinition {
         backgroundColor?: string;
@@ -7654,7 +7654,7 @@ declare module "libs/reach/feature/content/src/common/item-tile/PageItemTile" {
         showBreadcrumb?: boolean;
         showIntro?: boolean;
         onClick?: (event: React.MouseEvent<unknown>, isTitleClicked?: boolean) => unknown;
-        onKeywordClick?: (keyword: string) => unknown;
+        onKeywordClick?: (keywordId: string, keywordItem?: Keyword) => unknown;
         openTargetInNewWindow?: boolean;
         enableModalRouting?: boolean;
         showBanner?: boolean;
@@ -8366,7 +8366,7 @@ declare module "libs/reach/feature/content/src/events/index" {
 }
 declare module "libs/reach/feature/content/src/common/item-tile/EventItemTile" {
     import { FC, MouseEvent, ReactNode } from 'react';
-    import { EventItem } from "libs/reach/util/common/src/index";
+    import { Channel, EventItem } from "libs/reach/util/common/src/index";
     import { ItemTileLayoutMode } from "libs/reach/feature/content/src/common/item-tile/NewsItemTile";
     interface StyleDefinition {
         backgroundColor?: string;
@@ -8382,7 +8382,7 @@ declare module "libs/reach/feature/content/src/common/item-tile/EventItemTile" {
         buttons?: ReactNode;
         openTargetInNewWindow?: boolean;
         onClick?: (event: MouseEvent<unknown>) => unknown;
-        onChannelClick?: (channel: string) => unknown;
+        onChannelClick?: (channelName: string, channelItem?: Channel) => unknown;
         styleDefinition?: StyleDefinition;
         showBanner?: boolean;
         showBannerAlwaysOnTheLeft?: boolean;
@@ -8654,9 +8654,10 @@ declare module "libs/reach/feature/content/src/common/detail/events/controls/Eve
 }
 declare module "libs/reach/feature/content/src/common/detail/events/controls/EventDetailViewMetaInfo" {
     import { FC } from 'react';
+    import { Channel } from "libs/reach/util/common/src/index";
     export const EventDetailViewMetaInfo: FC<{
         allowFilterByChannels?: boolean;
-        onChannelClick?: (channel: string) => unknown;
+        onChannelClick?: (channelName: string, channelItem?: Channel) => unknown;
     }>;
 }
 declare module "libs/reach/feature/content/src/common/detail/events/controls/EventDetailViewDatesInfo" {
@@ -9030,7 +9031,7 @@ declare module "libs/reach/feature/content/src/news/ItemMetaInfo" {
         language?: string;
         buildChannelFilterUrl?: (channelName: string) => string;
         clickableAvatar?: boolean;
-        onChannelClick?: (channel: string) => unknown;
+        onChannelClick?: (channelName: string, channelItem?: Channel) => unknown;
     }>;
 }
 declare module "libs/reach/feature/content/src/news/list-view/ExternalNewsLinkButton" {
@@ -9447,9 +9448,10 @@ declare module "libs/reach/feature/content/src/common/detail/controls/DetailView
 }
 declare module "libs/reach/feature/content/src/common/detail/controls/DetailViewKeywords" {
     import { FC } from 'react';
+    import { Keyword } from "libs/reach/util/common/src/index";
     export const DetailViewKeywords: FC<{
         filterBaseUrl: string;
-        onKeywordClick?: (keyword: string) => unknown;
+        onKeywordClick?: (keywordId: string, keywordItem?: Keyword) => unknown;
     }>;
 }
 declare module "libs/reach/feature/content/src/common/detail/news/controls/DetailViewConfirmations" {
@@ -9728,9 +9730,10 @@ declare module "libs/reach/feature/content/src/stream/useStreamItemsQuery" {
     export function hasFilter(filter?: StreamFilterDefinition): boolean;
     export const getStreamQuery: (filter?: StreamFilterDefinition, allChannels?: Channel[], includeAllItems?: boolean) => DocumentNode;
     export const getSearchQuery: (filter?: StreamFilterDefinition, allChannels?: Channel[]) => DocumentNode;
+    export function getSupportedChannelsFilter(channels: FilterWithLogicalOperator, getSubscriptionChannels?: () => Promise<Channel[]>): Promise<FilterWithLogicalOperator>;
     export function getFilterConditionsString(filterConditions?: string[]): string;
     export const GROUPS_CONDITION: (groupIds: string[]) => string;
-    export const CHANNELS_CONDITION: (channels: FilterWithLogicalOperator, allChannels: Channel[]) => string;
+    export const CHANNELS_CONDITION: (channels: FilterWithLogicalOperator) => string;
     export const KEYWORDS_CONDITION: (keywords: FilterWithLogicalOperator) => string;
     export const OWNER_CONDITION: (owner: string) => string;
     export const PUBLISHING_DATE_CONDITION: (beforeDate: string, afterDate: string) => string;
@@ -9801,7 +9804,7 @@ declare module "libs/reach/feature/content/src/stream/streamUtils" {
     export interface NewsStreamItem extends NewsItem {
         type: StreamItemTypes.News;
         contentsList: StreamPublishableItemContents[];
-        channelsList: string[];
+        channelsList: Channel[];
         isUnread: boolean;
         keywordsList?: Keyword[];
         knownNewsState?: StreamKnownNewsState[];
@@ -9813,7 +9816,7 @@ declare module "libs/reach/feature/content/src/stream/streamUtils" {
     export interface EventStreamItem extends EventItem {
         type: StreamItemTypes.Event;
         contentsList: StreamPublishableItemContents[];
-        channelsList: string[];
+        channelsList: Channel[];
         isUnread: boolean;
         keywordsList?: Keyword[];
         userResponseType?: StreamEventResponse;
@@ -9822,7 +9825,7 @@ declare module "libs/reach/feature/content/src/stream/streamUtils" {
     export interface PageStreamItem extends PageItem {
         type: StreamItemTypes.Page;
         contentsList: StreamPublishableItemContents[];
-        channelsList: string[];
+        channelsList: Channel[];
         isUnread: boolean;
         keywordsList?: Keyword[];
         streamPageType?: string;
@@ -9882,7 +9885,7 @@ declare module "libs/reach/feature/content/src/stream/streamUtils" {
         };
         type: StreamItemTypes.News;
         contentsList: StreamPublishableItemContents[];
-        channelsList: string[];
+        channelsList: Channel[];
         isUnread: boolean;
         keywordsList?: Keyword[];
         knownNewsState?: StreamKnownNewsState[];
@@ -9928,7 +9931,7 @@ declare module "libs/reach/feature/content/src/stream/streamUtils" {
         };
         type: StreamItemTypes.Event;
         contentsList: StreamPublishableItemContents[];
-        channelsList: string[];
+        channelsList: Channel[];
         isUnread: boolean;
         keywordsList?: Keyword[];
         userResponseType?: StreamEventResponse;
@@ -9984,7 +9987,7 @@ declare module "libs/reach/feature/content/src/stream/streamUtils" {
         };
         type: StreamItemTypes.Page;
         contentsList: StreamPublishableItemContents[];
-        channelsList: string[];
+        channelsList: Channel[];
         isUnread: boolean;
         keywordsList?: Keyword[];
         streamPageType?: string;
@@ -10085,7 +10088,7 @@ declare module "libs/reach/feature/content/src/stream/streamUtils" {
             [p: string]: Keyword[];
         };
     })[];
-    export function convertProperties<TItem extends StreamItem = StreamItem>(items: TItem[], subscriptionChannels?: Channel[]): ((TItem & {
+    export function convertProperties<TItem extends StreamItem = StreamItem>(items: TItem[]): ((TItem & {
         keywords: {
             [key: string]: Keyword[];
         };

package/package.json

@@ -4,6 +4,6 @@
   "main": "",
   "types": "./index.d.ts",
   "license": "ISC",
-  "version": "0.5.0-preview.639",
+  "version": "0.5.0-preview.641",
   "dependencies": {}
 }