@livetiles/reach-plugin-types 0.4.0-preview.260 → 0.4.0-preview.263

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/lib/index.d.ts +121 -113
  2. package/package.json +1 -1
package/lib/index.d.ts CHANGED
@@ -6426,6 +6426,10 @@ declare module "libs/reach/feature/content/src/filter/BaseFilterDefinition" {
6426
6426
  export interface IndexableFilterDefinition {
6427
6427
  [key: string]: any;
6428
6428
  }
6429
+ export enum LogicalOperator {
6430
+ Or = "or",
6431
+ And = "and"
6432
+ }
6429
6433
  }
6430
6434
  declare module "libs/reach/feature/content/src/filter/SortFieldsDefinitionBuilder" {
6431
6435
  import { SortDirection } from "libs/reach/util/common/src/index";
@@ -6448,10 +6452,124 @@ declare module "libs/reach/feature/content/src/filter/EventContactsFilterDefinit
6448
6452
  contacts?: string[];
6449
6453
  }
6450
6454
  }
6455
+ declare module "libs/reach/feature/content/src/filter/AuthorFilterDefinition" {
6456
+ import { IndexableFilterDefinition } from "libs/reach/feature/content/src/filter/BaseFilterDefinition";
6457
+ export interface AuthorFilterDefinition extends IndexableFilterDefinition {
6458
+ author?: string;
6459
+ }
6460
+ }
6461
+ declare module "libs/reach/feature/content/src/filter/FilteringProps" {
6462
+ import { IndexableFilterDefinition } from "libs/reach/feature/content/src/filter/BaseFilterDefinition";
6463
+ export interface FilteringProps {
6464
+ onFilterChange?: (filter: Partial<IndexableFilterDefinition>) => void;
6465
+ onShowFilterPanel?: () => unknown;
6466
+ onToggleFilterSidebar?: () => unknown;
6467
+ isFilterActive?: boolean;
6468
+ }
6469
+ }
6470
+ declare module "libs/reach/feature/content/src/filter/StateFilterDefinition" {
6471
+ import { IndexableFilterDefinition } from "libs/reach/feature/content/src/filter/BaseFilterDefinition";
6472
+ import { WorkflowStatus } from "libs/reach/util/common/src/index";
6473
+ export interface StateFilterDefinition extends IndexableFilterDefinition {
6474
+ state?: WorkflowStatus;
6475
+ }
6476
+ }
6477
+ declare module "libs/reach/feature/content/src/filter/NewsFilterDefinition" {
6478
+ import { AuthorFilterDefinition } from "libs/reach/feature/content/src/filter/AuthorFilterDefinition";
6479
+ import { PublishableItemFilterDefinition } from "libs/reach/feature/content/src/filter/BaseFilterDefinition";
6480
+ import { ChannelsFilterDefinition } from "libs/reach/feature/content/src/filter/ChannelsFilterDefinition";
6481
+ import { StateFilterDefinition } from "libs/reach/feature/content/src/filter/StateFilterDefinition";
6482
+ export interface NewsFilterDefinition extends PublishableItemFilterDefinition, AuthorFilterDefinition, ChannelsFilterDefinition, StateFilterDefinition {
6483
+ groupId?: string;
6484
+ bookmarksOnly?: boolean;
6485
+ unreadOnly?: boolean;
6486
+ }
6487
+ }
6488
+ declare module "libs/reach/feature/content/src/filter/ItemTypeFilterDefinition" {
6489
+ import { IndexableFilterDefinition } from "libs/reach/feature/content/src/filter/BaseFilterDefinition";
6490
+ export enum ItemType {
6491
+ None = 0,
6492
+ News = 1,
6493
+ Post = 2,
6494
+ Page = 4,
6495
+ Event = 8
6496
+ }
6497
+ export interface ItemTypeFilterDefinition extends IndexableFilterDefinition {
6498
+ itemType?: ItemType;
6499
+ }
6500
+ }
6501
+ declare module "libs/reach/feature/content/src/filter/useFilter" {
6502
+ import { FC } from 'react';
6503
+ import { IndexableFilterDefinition } from "libs/reach/feature/content/src/filter/BaseFilterDefinition";
6504
+ import { CurrentUser } from "libs/reach/util/common/src/index";
6505
+ export interface InjectedFilterProps {
6506
+ filter: IndexableFilterDefinition;
6507
+ hasFilter: boolean;
6508
+ isSearchActive: boolean;
6509
+ onFilterChange: (filter: Partial<IndexableFilterDefinition>) => void;
6510
+ onSearchChange: (text: string) => void;
6511
+ onClearFilter: () => void;
6512
+ }
6513
+ export function useFilter<TQueryString extends Object = any>(addFilters?: (routeParams: any, user: CurrentUser) => Partial<IndexableFilterDefinition>, onClearQueryString?: (prev: TQueryString, next: TQueryString) => TQueryString, additionalExcludedFilterProperties?: string[]): {
6514
+ filter: Partial<IndexableFilterDefinition>;
6515
+ hasFilter: boolean;
6516
+ isSearchActive: boolean;
6517
+ onFilterChange: (newFilter: Partial<IndexableFilterDefinition> | null) => void;
6518
+ onSearchChange: (search: string) => void;
6519
+ onClearFilter: () => void;
6520
+ };
6521
+ export const FilterContext: import("react").Context<InjectedFilterProps>;
6522
+ export const FilterContextProvider: FC<{
6523
+ addFilters?: (locationParams: {
6524
+ [paramName: string]: any;
6525
+ }, user: CurrentUser) => IndexableFilterDefinition;
6526
+ additionalExcludedFilterProperties?: string[];
6527
+ onClearQueryString?: (prev: any, next: any) => any;
6528
+ }>;
6529
+ export interface FilterVisibilityState {
6530
+ showFilterAsPanel?: boolean;
6531
+ showFilterSidebar?: boolean;
6532
+ }
6533
+ }
6534
+ declare module "libs/reach/feature/content/src/filter/utils" {
6535
+ export function getCommaSeparatedChannelsString(channels: string[]): {
6536
+ channels?: undefined;
6537
+ } | {
6538
+ channels: string;
6539
+ };
6540
+ export function getCommaSeparatedKeywordsString(keywords: string[]): {
6541
+ keywords?: undefined;
6542
+ } | {
6543
+ keywords: string;
6544
+ };
6545
+ }
6546
+ declare module "libs/reach/feature/content/src/filter/index" {
6547
+ export * from "libs/reach/feature/content/src/filter/AuthorFilterDefinition";
6548
+ export * from "libs/reach/feature/content/src/filter/BaseFilterDefinition";
6549
+ export * from "libs/reach/feature/content/src/filter/BeforePublishingDateFilterDefinition";
6550
+ export * from "libs/reach/feature/content/src/filter/ChannelsFilterDefinition";
6551
+ export * from "libs/reach/feature/content/src/filter/EventContactsFilterDefinition";
6552
+ export * from "libs/reach/feature/content/src/filter/EventFilterDefinition";
6553
+ export * from "libs/reach/feature/content/src/filter/EventsStartDateFilterDefinition";
6554
+ export * from "libs/reach/feature/content/src/filter/FilteringProps";
6555
+ export * from "libs/reach/feature/content/src/filter/KeywordsFilterDefinition";
6556
+ export * from "libs/reach/feature/content/src/filter/NewsFilterDefinition";
6557
+ export * from "libs/reach/feature/content/src/filter/OwnerFilterDefinition";
6558
+ export * from "libs/reach/feature/content/src/filter/SortFieldsDefinitionBuilder";
6559
+ export * from "libs/reach/feature/content/src/filter/SourceFilterDefinition";
6560
+ export * from "libs/reach/feature/content/src/filter/StateFilterDefinition";
6561
+ export * from "libs/reach/feature/content/src/filter/ItemTypeFilterDefinition";
6562
+ export * from "libs/reach/feature/content/src/filter/useFilter";
6563
+ export * from "libs/reach/feature/content/src/filter/utils";
6564
+ }
6451
6565
  declare module "libs/reach/feature/content/src/filter/ChannelsFilterDefinition" {
6566
+ import { LogicalOperator } from "libs/reach/feature/content/src/filter/index";
6452
6567
  import { IndexableFilterDefinition } from "libs/reach/feature/content/src/filter/BaseFilterDefinition";
6453
6568
  export interface ChannelsFilterDefinition extends IndexableFilterDefinition {
6454
- channels?: string[];
6569
+ channels?: {
6570
+ items?: string[];
6571
+ operator?: LogicalOperator;
6572
+ };
6455
6573
  }
6456
6574
  }
6457
6575
  declare module "libs/reach/feature/content/src/filter/EventFilterDefinition" {
@@ -6471,18 +6589,6 @@ declare module "libs/reach/feature/content/src/filter/EventFilterDefinition" {
6471
6589
  export const eventsPastViewSortDefinition: EventSortFieldsDefinitionBuilder;
6472
6590
  export const eventsLatestViewSortDefinition: EventSortFieldsDefinitionBuilder;
6473
6591
  }
6474
- declare module "libs/reach/feature/content/src/filter/utils" {
6475
- export function getCommaSeparatedChannelsString(channels: string[]): {
6476
- channels?: undefined;
6477
- } | {
6478
- channels: string;
6479
- };
6480
- export function getCommaSeparatedKeywordsString(keywords: string[]): {
6481
- keywords?: undefined;
6482
- } | {
6483
- keywords: string;
6484
- };
6485
- }
6486
6592
  declare module "libs/reach/feature/content/src/events/useEventsApi" {
6487
6593
  import { EventFilterDefinition, EventSortFieldsDefinitionBuilder } from "libs/reach/feature/content/src/filter/EventFilterDefinition";
6488
6594
  import { PaginatedList } from "libs/reach/util/common/src/index";
@@ -6493,30 +6599,6 @@ declare module "libs/reach/feature/content/src/events/useEventsApi" {
6493
6599
  getEventRecurrences: (eventId: string, from: string, to: string) => Promise<EventRecurrenceInfo[]>;
6494
6600
  };
6495
6601
  }
6496
- declare module "libs/reach/feature/content/src/filter/AuthorFilterDefinition" {
6497
- import { IndexableFilterDefinition } from "libs/reach/feature/content/src/filter/BaseFilterDefinition";
6498
- export interface AuthorFilterDefinition extends IndexableFilterDefinition {
6499
- author?: string;
6500
- }
6501
- }
6502
- declare module "libs/reach/feature/content/src/filter/StateFilterDefinition" {
6503
- import { IndexableFilterDefinition } from "libs/reach/feature/content/src/filter/BaseFilterDefinition";
6504
- import { WorkflowStatus } from "libs/reach/util/common/src/index";
6505
- export interface StateFilterDefinition extends IndexableFilterDefinition {
6506
- state?: WorkflowStatus;
6507
- }
6508
- }
6509
- declare module "libs/reach/feature/content/src/filter/NewsFilterDefinition" {
6510
- import { AuthorFilterDefinition } from "libs/reach/feature/content/src/filter/AuthorFilterDefinition";
6511
- import { PublishableItemFilterDefinition } from "libs/reach/feature/content/src/filter/BaseFilterDefinition";
6512
- import { ChannelsFilterDefinition } from "libs/reach/feature/content/src/filter/ChannelsFilterDefinition";
6513
- import { StateFilterDefinition } from "libs/reach/feature/content/src/filter/StateFilterDefinition";
6514
- export interface NewsFilterDefinition extends PublishableItemFilterDefinition, AuthorFilterDefinition, ChannelsFilterDefinition, StateFilterDefinition {
6515
- groupId?: string;
6516
- bookmarksOnly?: boolean;
6517
- unreadOnly?: boolean;
6518
- }
6519
- }
6520
6602
  declare module "libs/reach/feature/content/src/news/fetchNewsItems" {
6521
6603
  import { NewsFilterDefinition } from "libs/reach/feature/content/src/filter/NewsFilterDefinition";
6522
6604
  import { Observable } from 'rxjs';
@@ -9042,80 +9124,6 @@ declare module "libs/reach/feature/content/src/feedback/index" {
9042
9124
  export * from "libs/reach/feature/content/src/feedback/PollTranslationContext";
9043
9125
  export * from "libs/reach/feature/content/src/feedback/utils";
9044
9126
  }
9045
- declare module "libs/reach/feature/content/src/filter/FilteringProps" {
9046
- import { IndexableFilterDefinition } from "libs/reach/feature/content/src/filter/BaseFilterDefinition";
9047
- export interface FilteringProps {
9048
- onFilterChange?: (filter: Partial<IndexableFilterDefinition>) => void;
9049
- onShowFilterPanel?: () => unknown;
9050
- onToggleFilterSidebar?: () => unknown;
9051
- isFilterActive?: boolean;
9052
- }
9053
- }
9054
- declare module "libs/reach/feature/content/src/filter/ItemTypeFilterDefinition" {
9055
- import { IndexableFilterDefinition } from "libs/reach/feature/content/src/filter/BaseFilterDefinition";
9056
- export enum ItemType {
9057
- None = 0,
9058
- News = 1,
9059
- Post = 2,
9060
- Page = 4,
9061
- Event = 8
9062
- }
9063
- export interface ItemTypeFilterDefinition extends IndexableFilterDefinition {
9064
- itemType?: ItemType;
9065
- }
9066
- }
9067
- declare module "libs/reach/feature/content/src/filter/useFilter" {
9068
- import { FC } from 'react';
9069
- import { IndexableFilterDefinition } from "libs/reach/feature/content/src/filter/BaseFilterDefinition";
9070
- import { CurrentUser } from "libs/reach/util/common/src/index";
9071
- export interface InjectedFilterProps {
9072
- filter: IndexableFilterDefinition;
9073
- hasFilter: boolean;
9074
- isSearchActive: boolean;
9075
- onFilterChange: (filter: Partial<IndexableFilterDefinition>) => void;
9076
- onSearchChange: (text: string) => void;
9077
- onClearFilter: () => void;
9078
- }
9079
- export function useFilter<TQueryString extends Object = any>(addFilters?: (routeParams: any, user: CurrentUser) => Partial<IndexableFilterDefinition>, onClearQueryString?: (prev: TQueryString, next: TQueryString) => TQueryString, additionalExcludedFilterProperties?: string[]): {
9080
- filter: Partial<IndexableFilterDefinition>;
9081
- hasFilter: boolean;
9082
- isSearchActive: boolean;
9083
- onFilterChange: (newFilter: Partial<IndexableFilterDefinition> | null) => void;
9084
- onSearchChange: (search: string) => void;
9085
- onClearFilter: () => void;
9086
- };
9087
- export const FilterContext: import("react").Context<InjectedFilterProps>;
9088
- export const FilterContextProvider: FC<{
9089
- addFilters?: (locationParams: {
9090
- [paramName: string]: any;
9091
- }, user: CurrentUser) => IndexableFilterDefinition;
9092
- additionalExcludedFilterProperties?: string[];
9093
- onClearQueryString?: (prev: any, next: any) => any;
9094
- }>;
9095
- export interface FilterVisibilityState {
9096
- showFilterAsPanel?: boolean;
9097
- showFilterSidebar?: boolean;
9098
- }
9099
- }
9100
- declare module "libs/reach/feature/content/src/filter/index" {
9101
- export * from "libs/reach/feature/content/src/filter/AuthorFilterDefinition";
9102
- export * from "libs/reach/feature/content/src/filter/BaseFilterDefinition";
9103
- export * from "libs/reach/feature/content/src/filter/BeforePublishingDateFilterDefinition";
9104
- export * from "libs/reach/feature/content/src/filter/ChannelsFilterDefinition";
9105
- export * from "libs/reach/feature/content/src/filter/EventContactsFilterDefinition";
9106
- export * from "libs/reach/feature/content/src/filter/EventFilterDefinition";
9107
- export * from "libs/reach/feature/content/src/filter/EventsStartDateFilterDefinition";
9108
- export * from "libs/reach/feature/content/src/filter/FilteringProps";
9109
- export * from "libs/reach/feature/content/src/filter/KeywordsFilterDefinition";
9110
- export * from "libs/reach/feature/content/src/filter/NewsFilterDefinition";
9111
- export * from "libs/reach/feature/content/src/filter/OwnerFilterDefinition";
9112
- export * from "libs/reach/feature/content/src/filter/SortFieldsDefinitionBuilder";
9113
- export * from "libs/reach/feature/content/src/filter/SourceFilterDefinition";
9114
- export * from "libs/reach/feature/content/src/filter/StateFilterDefinition";
9115
- export * from "libs/reach/feature/content/src/filter/ItemTypeFilterDefinition";
9116
- export * from "libs/reach/feature/content/src/filter/useFilter";
9117
- export * from "libs/reach/feature/content/src/filter/utils";
9118
- }
9119
9127
  declare module "libs/reach/feature/content/src/forms/keyword-picker/KeywordPickerGroup" {
9120
9128
  import { Keyword, KeywordGroup } from "libs/reach/util/common/src/index";
9121
9129
  import { FC } from 'react';
@@ -10740,7 +10748,7 @@ declare module "libs/reach/feature/content/src/stream/useStreamItemsQuery" {
10740
10748
  import { StreamItem } from "libs/reach/feature/content/src/stream/streamUtils";
10741
10749
  import { DocumentNode } from '@apollo/client';
10742
10750
  import { Channel } from "libs/reach/util/common/src/index";
10743
- import { BeforePublishingDateFilterDefinition, ChannelsFilterDefinition, ItemTypeFilterDefinition, KeywordsFilterDefinition, OwnerFilterDefinition } from "libs/reach/feature/content/src/filter/index";
10751
+ import { BeforePublishingDateFilterDefinition, ChannelsFilterDefinition, ItemTypeFilterDefinition, KeywordsFilterDefinition, OwnerFilterDefinition, LogicalOperator } from "libs/reach/feature/content/src/filter/index";
10744
10752
  export enum StreamEventResponse {
10745
10753
  NotSet = "NOTSET",
10746
10754
  Registered = "REGISTERED",
@@ -10761,7 +10769,7 @@ declare module "libs/reach/feature/content/src/stream/useStreamItemsQuery" {
10761
10769
  };
10762
10770
  export const getStreamQuery: () => DocumentNode;
10763
10771
  export const getSearchQuery: (filter?: StreamFilterDefinition, allChannels?: Channel[]) => DocumentNode;
10764
- export const CHANNELS_OR_CONDITION: (channels: string[], allChannels: Channel[]) => string;
10772
+ export const CHANNELS_CONDITION: (channels: string[], allChannels: Channel[], operator?: LogicalOperator) => string;
10765
10773
  export const KEYWORDS_OR_CONDITION: (keywords: string[]) => string;
10766
10774
  export const OWNER_CONDITION: (owner: string) => string;
10767
10775
  export const PUBLISHING_DATE_CONDITION: (beforeDate: string, afterDate: string) => string;
package/package.json CHANGED
@@ -4,6 +4,6 @@
4
4
  "main": "",
5
5
  "types": "./index.d.ts",
6
6
  "license": "ISC",
7
- "version": "0.4.0-preview.260",
7
+ "version": "0.4.0-preview.263",
8
8
  "dependencies": {}
9
9
  }