From f7944dd393511869fedf643ef83f5b5cdb92fe1d Mon Sep 17 00:00:00 2001
From: Petr Jasek <jasekpetr@gmail.com>
Date: Wed, 15 May 2024 09:09:17 +0200
Subject: [PATCH 1/4] implement ui config for hiding item type filters in
 agenda

STTNHUB-238
---
 assets/agenda/components/AgendaApp.tsx        |  6 ---
 assets/agenda/components/AgendaFilters.tsx    | 51 ++++++++++---------
 .../components/AgendaItemTypeFilter.tsx       | 40 ++++++++-------
 assets/agenda/selectors.ts                    | 10 ++--
 assets/interfaces/agenda.ts                   | 10 +++-
 assets/interfaces/configs.ts                  | 10 +++-
 6 files changed, 73 insertions(+), 54 deletions(-)

diff --git a/assets/agenda/components/AgendaApp.tsx b/assets/agenda/components/AgendaApp.tsx
index be73266f9..860b3ba3a 100644
--- a/assets/agenda/components/AgendaApp.tsx
+++ b/assets/agenda/components/AgendaApp.tsx
@@ -234,13 +234,11 @@ class AgendaApp extends SearchBase<any> {
                             <div className='wire-column__main-header-container'>
                                 {!this.props.bookmarks && (
                                     <AgendaFilters
-                                        aggregations={this.props.aggregations}
                                         toggleFilter={this.props.toggleDropdownFilter}
                                         activeFilter={this.props.activeFilter}
                                         eventsOnlyAccess={this.props.eventsOnlyAccess}
                                         restrictCoverageInfo={this.props.restrictCoverageInfo}
                                         itemTypeFilter={this.props.itemTypeFilter}
-                                        locators={this.props.locators}
                                     />
                                 )}
                                 {
@@ -350,7 +348,6 @@ AgendaApp.propTypes = {
     closePreview: PropTypes.func,
     navigations: PropTypes.array.isRequired,
     activeNavigation: PropTypes.arrayOf(PropTypes.string),
-    aggregations: PropTypes.object,
     toggleDropdownFilter: PropTypes.func,
     selectDate: PropTypes.func,
     activeDate: PropTypes.number,
@@ -365,7 +362,6 @@ AgendaApp.propTypes = {
     eventsOnlyAccess: PropTypes.bool,
     restrictCoverageInfo: PropTypes.bool,
     itemTypeFilter: PropTypes.string,
-    locators: PropTypes.array,
     searchParams: PropTypes.object,
     showSaveTopic: PropTypes.bool,
     previewConfig: PropTypes.object,
@@ -395,7 +391,6 @@ const mapStateToProps = (state: any) => ({
     activeTopic: activeTopicSelector(state),
     activeNavigation: searchNavigationSelector(state),
     bookmarks: state.bookmarks,
-    aggregations: state.aggregations,
     activeDate: get(state, 'agenda.activeDate'),
     activeGrouping: get(state, 'agenda.activeGrouping'),
     eventsOnlyAccess: get(state, 'agenda.eventsOnlyAccess', false),
@@ -406,7 +401,6 @@ const mapStateToProps = (state: any) => ({
     userSections: state.userSections,
     featuredOnly: get(state, 'agenda.featuredOnly'),
     context: state.context,
-    locators: get(state, 'locators.items', []),
     setQuery: PropTypes.func.isRequired,
     searchParams: searchParamsSelector(state),
     showSaveTopic: showSaveTopicSelector(state),
diff --git a/assets/agenda/components/AgendaFilters.tsx b/assets/agenda/components/AgendaFilters.tsx
index b100d002d..8ec98d689 100644
--- a/assets/agenda/components/AgendaFilters.tsx
+++ b/assets/agenda/components/AgendaFilters.tsx
@@ -1,5 +1,4 @@
 import React from 'react';
-import PropTypes from 'prop-types';
 import {connect} from 'react-redux';
 import {get} from 'lodash';
 
@@ -12,6 +11,8 @@ import AgendaCoverageExistsFilter from './AgendaCoverageExistsFilter';
 import AgendaItemTypeFilter from './AgendaItemTypeFilter';
 import {AgendaCalendarAgendaFilter} from './AgendaCalendarAgendaFilter';
 import {LocationFilter} from './LocationFilter';
+import {IAgendaState} from 'interfaces/agenda';
+import {ISearchState} from 'interfaces/search';
 
 export const transformFilterBuckets = (filter: any, aggregations: any, props: any) => {
     if (!filter.transformBuckets) {
@@ -21,17 +22,18 @@ export const transformFilterBuckets = (filter: any, aggregations: any, props: an
     return filter.transformBuckets(filter, aggregations, props);
 };
 
-const renderFilter: any = {
-    item_type: (props: any) => (
+const renderFilter = {
+    item_type: (props: IProps) => (
         <AgendaItemTypeFilter
             key="item_type"
             itemTypeFilter={props.itemTypeFilter}
             toggleFilter={props.toggleFilter}
             eventsOnlyAccess={props.eventsOnlyAccess}
             restrictCoverageInfo={props.restrictCoverageInfo}
+            config={props.itemTypeFilterConfig}
         />
     ),
-    calendar: (props: any) => (
+    calendar: (props: IProps) => (
         <AgendaCalendarAgendaFilter
             key="calendar"
             aggregations={props.aggregations}
@@ -40,7 +42,7 @@ const renderFilter: any = {
             itemTypeFilter={props.itemTypeFilter}
         />
     ),
-    location: (props: any) => (
+    location: (props: IProps) => (
         !['events', 'combined'].includes(props.itemTypeFilter || 'combined') ? null : (
             <LocationFilter
                 key="location"
@@ -49,7 +51,7 @@ const renderFilter: any = {
             />
         )
     ),
-    region: (props: any) => (
+    region: (props: IProps) => (
         !['events', 'planning', 'combined'].includes(props.itemTypeFilter || 'combined') ? null : (
             <DropdownFilter
                 key="region"
@@ -84,7 +86,7 @@ const renderFilter: any = {
             />
         )
     ),
-    coverage_type: (props: any) => (
+    coverage_type: (props: IProps) => (
         !['planning', 'combined'].includes(props.itemTypeFilter || 'combined') ? null : (
             <DropdownFilter
                 filterName={gettext('Coverage types')}
@@ -105,7 +107,7 @@ const renderFilter: any = {
             />
         )
     ),
-    coverage_status: (props: any) => (
+    coverage_status: (props: IProps) => (
         (props.eventsOnlyAccess || props.itemTypeFilter === 'events') ? null : (
             <AgendaCoverageExistsFilter
                 key="coverage_status"
@@ -128,31 +130,34 @@ export function getDropdownItems(filter: any, aggregations: any, toggleFilter: a
     return [];
 }
 
-function AgendaFiltersComponent(props: any) {
+function AgendaFiltersComponent(props: IProps) {
     return (
         <div className='navbar navbar--flex navbar--quick-filter'>
-            {props.filtersConfig.map((filterName: any) => (
+            {props.filtersConfig.map((filterName) => (
                 renderFilter[filterName](props)
             ))}
         </div>
     );
 }
 
-AgendaFiltersComponent.propTypes = {
-    aggregations: PropTypes.object,
-    toggleFilter: PropTypes.func,
-    activeFilter: PropTypes.object,
-    eventsOnlyAccess: PropTypes.bool,
-    restrictCoverageInfo: PropTypes.bool,
-    itemTypeFilter: PropTypes.string,
-    locators: PropTypes.arrayOf(PropTypes.object),
-    filtersConfig: PropTypes.arrayOf(PropTypes.string),
-};
+interface IOwnProps {
+    toggleFilter: (fieldName: string, value?: string | null) => void;
+    activeFilter: ISearchState['activeFilter'];
+    eventsOnlyAccess: boolean;
+    restrictCoverageInfo: boolean;
+    itemTypeFilter?: 'events' | 'planning' | 'combined';
+}
 
-const mapStateToProps = (state: any) => ({
+const mapStateToProps = (state: IAgendaState) => ({
+    aggregations: state.aggregations,
     filtersConfig: agendaFiltersConfigSelector(state),
+    locators: state.locators?.items || [],
+    itemTypeFilterConfig: state.uiConfig.subnav?.item_type || {},
+    subnavConfig: state,
 });
 
-const AgendaFilters: React.ComponentType<any> = connect(mapStateToProps)(AgendaFiltersComponent);
+type StateProps = ReturnType<typeof mapStateToProps>;
+
+type IProps = StateProps & IOwnProps;
 
-export default AgendaFilters;
+export default connect<StateProps, null, IOwnProps, IAgendaState>(mapStateToProps)(AgendaFiltersComponent);
diff --git a/assets/agenda/components/AgendaItemTypeFilter.tsx b/assets/agenda/components/AgendaItemTypeFilter.tsx
index 788316f62..a68f269cd 100644
--- a/assets/agenda/components/AgendaItemTypeFilter.tsx
+++ b/assets/agenda/components/AgendaItemTypeFilter.tsx
@@ -1,9 +1,17 @@
 import React from 'react';
-import PropTypes from 'prop-types';
 import {gettext} from 'utils';
 import {AgendaDropdown} from './AgendaDropdown';
+import {ItemTypeFilterConfig} from 'interfaces/configs';
 
-function AgendaItemTypeFilter ({toggleFilter, itemTypeFilter, eventsOnlyAccess, restrictCoverageInfo}: any) {
+interface IProps {
+    toggleFilter: (filedName: string, value: string | null) => void;
+    itemTypeFilter?: 'events' | 'planning' | 'combined';
+    eventsOnlyAccess: boolean;
+    restrictCoverageInfo: boolean;
+    config?: ItemTypeFilterConfig;
+}
+
+function AgendaItemTypeFilter ({toggleFilter, itemTypeFilter, eventsOnlyAccess, restrictCoverageInfo, config}: IProps) {
     if (eventsOnlyAccess) {
         return null;
     }
@@ -16,7 +24,7 @@ function AgendaItemTypeFilter ({toggleFilter, itemTypeFilter, eventsOnlyAccess,
         ]
     };
 
-    const filter: any = {
+    const filter = {
         label: gettext('Events & Coverages'),
         field: 'itemType',
     };
@@ -32,14 +40,16 @@ function AgendaItemTypeFilter ({toggleFilter, itemTypeFilter, eventsOnlyAccess,
             //dropdownMenuHeader={gettext('Item Types')}
             hideLabelOnMobile
         >
-            <button
-                key="events_only"
-                className="dropdown-item"
-                onClick={() => toggleFilter(filter.field, 'events')}
-            >
-                {gettext('Events Only')}
-            </button>
-            {restrictCoverageInfo ? null : (
+            {config?.events_only === false ? null : (
+                <button
+                    key="events_only"
+                    className="dropdown-item"
+                    onClick={() => toggleFilter(filter.field, 'events')}
+                >
+                    {gettext('Events Only')}
+                </button>
+            )}
+            {restrictCoverageInfo || config?.planning_only === false ? null : (
                 <button
                     key="planning_only"
                     className="dropdown-item"
@@ -52,12 +62,4 @@ function AgendaItemTypeFilter ({toggleFilter, itemTypeFilter, eventsOnlyAccess,
     );
 }
 
-AgendaItemTypeFilter.propTypes = {
-    toggleFilter: PropTypes.func,
-    itemTypeFilter: PropTypes.string,
-    eventsOnlyAccess: PropTypes.bool,
-    restrictCoverageInfo: PropTypes.bool,
-};
-
-
 export default AgendaItemTypeFilter;
diff --git a/assets/agenda/selectors.ts b/assets/agenda/selectors.ts
index 7b2d6b96f..1efaacd25 100644
--- a/assets/agenda/selectors.ts
+++ b/assets/agenda/selectors.ts
@@ -1,11 +1,13 @@
-import {get} from 'lodash';
-import {uiConfigSelector} from 'ui/selectors';
+import {IAgendaState} from 'interfaces/agenda';
+import {AgendaFilterTypes} from 'interfaces/configs';
 
-export const agendaFiltersConfigSelector = (state: any) => get(uiConfigSelector(state), 'subnav.filters') || [
+export const agendaFiltersConfigSelector = (state: IAgendaState): AgendaFilterTypes[] => (state.uiConfig.subnav?.filters || [
     'item_type',
     'calendar',
     'location',
     'region',
     'coverage_type',
     'coverage_status',
-];
+]);
+
+export const agendaSubnavItemTypeConfigSelector = (state: IAgendaState) => (state.uiConfig.subnav?.item_type || {});
diff --git a/assets/interfaces/agenda.ts b/assets/interfaces/agenda.ts
index 8fe90fcfb..630d98972 100644
--- a/assets/interfaces/agenda.ts
+++ b/assets/interfaces/agenda.ts
@@ -241,6 +241,14 @@ export interface IAgendaListGroupItem {
     plan?: IAgendaItem['_id'];
 }
 
+export interface IAggregation {  // incomplete
+    field: string;
+    buckets: Array<{
+        key: string;
+        doc_count: number;
+    }>;
+}
+
 export interface IAgendaState {
     items: Array<IAgendaItem['_id']>;
     fetchFrom: number;
@@ -249,7 +257,7 @@ export interface IAgendaState {
         groups: Array<IAgendaListGroup>;
         hiddenGroupsShown: {[dateString: string]: boolean};
     };
-    aggregations?: {[field: string]: any}; // Too complex to even bother
+    aggregations?: {[field: string]: IAggregation};
     activeItem?: IAgendaListGroupItem;
     previewItem?: IAgendaItem['_id'];
     previewGroup?: string;
diff --git a/assets/interfaces/configs.ts b/assets/interfaces/configs.ts
index 066f70a32..8468d63de 100644
--- a/assets/interfaces/configs.ts
+++ b/assets/interfaces/configs.ts
@@ -79,11 +79,19 @@ export interface IAgendaPreviewConfig extends IPreviewConfig {
     coverage_metadata_fields?: Array<string>;
 }
 
+export type AgendaFilterTypes = 'item_type' | 'calendar' | 'location' | 'region' | 'coverage_type' | 'coverage_status';
+
+export interface ItemTypeFilterConfig {
+    events_only?: boolean;
+    planning_only?: boolean;
+}
+
 export interface IAgendaUIConfig extends IBaseUIConfig {
     _id: 'agenda';
     open_coverage_content_in_same_page?: boolean;
     subnav?: {
-        filters?: Array<string>;
+        filters?: Array<AgendaFilterTypes>;
+        item_type?: ItemTypeFilterConfig;
     };
     preview?: IAgendaPreviewConfig;
     details?: IAgendaPreviewConfig;

From 32b8dbe21e1f49dfe196f73e6f1c6b3b88cccc5b Mon Sep 17 00:00:00 2001
From: Petr Jasek <jasekpetr@gmail.com>
Date: Wed, 15 May 2024 14:36:01 +0200
Subject: [PATCH 2/4] add config to hide planning items by default

---
 newsroom/agenda/agenda.py        | 19 +++++++++++++++++++
 newsroom/web/default_settings.py |  6 ++++++
 2 files changed, 25 insertions(+)

diff --git a/newsroom/agenda/agenda.py b/newsroom/agenda/agenda.py
index 4dcbf9121..e33b6c6e2 100644
--- a/newsroom/agenda/agenda.py
+++ b/newsroom/agenda/agenda.py
@@ -945,6 +945,25 @@ def apply_filters(self, search: SearchQuery, section_filters=None):
                     }
                 }
             )
+        elif app.config.get("AGENDA_DEFAULT_FILTER_HIDE_PLANNING"):
+            search.query["bool"]["filter"].append(
+                {
+                    "bool": {
+                        "should": [
+                            {"term": {"item_type": "event"}},
+                            {
+                                # Match Events before ``item_type`` field was added
+                                "bool": {
+                                    "must_not": [{"exists": {"field": "item_type"}}],
+                                    "filter": [{"exists": {"field": "event_id"}}],
+                                },
+                            },
+                        ],
+                        "minimum_should_match": 1,
+                    },
+                }
+            )
+            _remove_fields(search.source, ["planning_items", "display_dates"])
         else:
             # Don't include Planning items that are associated with an Event
             search.query["bool"]["filter"].append(
diff --git a/newsroom/web/default_settings.py b/newsroom/web/default_settings.py
index 0ed0e8582..13e336ba5 100644
--- a/newsroom/web/default_settings.py
+++ b/newsroom/web/default_settings.py
@@ -799,3 +799,9 @@
 #: .. versionadded: 2.7
 #:
 AGENDA_HIDE_COVERAGE_ASSIGNEES = False
+
+#: Hides planning items from the default item type filter
+#:
+#: .. versionadded: 2.8
+#:
+AGENDA_DEFAULT_FILTER_HIDE_PLANNING = False
\ No newline at end of file

From 683c4e9562aef0dd902d142a771d01d8fa8f6479 Mon Sep 17 00:00:00 2001
From: Petr Jasek <jasekpetr@gmail.com>
Date: Wed, 15 May 2024 14:37:20 +0200
Subject: [PATCH 3/4] fix lint

---
 newsroom/web/default_settings.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/newsroom/web/default_settings.py b/newsroom/web/default_settings.py
index 13e336ba5..4756caf20 100644
--- a/newsroom/web/default_settings.py
+++ b/newsroom/web/default_settings.py
@@ -804,4 +804,4 @@
 #:
 #: .. versionadded: 2.8
 #:
-AGENDA_DEFAULT_FILTER_HIDE_PLANNING = False
\ No newline at end of file
+AGENDA_DEFAULT_FILTER_HIDE_PLANNING = False

From 866b150b787cef31f276d57fd1c72efdcedb86ed Mon Sep 17 00:00:00 2001
From: Petr Jasek <jasekpetr@gmail.com>
Date: Thu, 16 May 2024 09:38:44 +0200
Subject: [PATCH 4/4] docs

---
 docs/config-ui.rst    | 33 +++++++++++++++++++++++++++++++++
 docs/index.rst        |  8 ++++++++
 docs/requirements.txt |  2 --
 3 files changed, 41 insertions(+), 2 deletions(-)
 create mode 100644 docs/config-ui.rst

diff --git a/docs/config-ui.rst b/docs/config-ui.rst
new file mode 100644
index 000000000..06fa524ba
--- /dev/null
+++ b/docs/config-ui.rst
@@ -0,0 +1,33 @@
+UI Config
+=========
+
+Agenda
+------
+
+``open_coverage_content_in_same_page``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: ``true``
+
+When set to ``true``, clicking on a coverage in the agenda will open the coverage in the same page. When set to ``false``, clicking on a coverage will open the coverage in a new tab.
+
+``subnav.filters``
+^^^^^^^^^^^^^^^^^^
+
+Default: ``['item_type', 'calendar', 'location', 'region', 'coverage_type', 'coverage_status']``
+
+List of filters that will be used in the agenda subnavigation, by default all are visible.
+
+``subnav.item_type.events_only``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: ``true``
+
+Set to ``false`` to hide the *Events only* filter.
+
+``subnav.item_type.planning_only``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: ``true``
+
+Set to ``false`` to hide the *Planning only* filter.
\ No newline at end of file
diff --git a/docs/index.rst b/docs/index.rst
index a5911dc57..b919ba474 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -17,6 +17,14 @@ Developers Guide
     developers
     company
 
+Configuration
+-------------
+
+.. toctree::
+    :maxdepth: 2
+
+    config-ui
+
 API Reference
 -------------
 
diff --git a/docs/requirements.txt b/docs/requirements.txt
index de79bffbe..8d957d7f2 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,4 +1,2 @@
--e ..
-
 sphinx
 sphinx-autobuild