@eeacms/volto-globalsearch 1.0.10 → 1.0.12

package/CHANGELOG.md

@@ -4,6 +4,22 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+### [1.0.12](https://github.com/eea/volto-globalsearch/compare/1.0.11...1.0.12) - 1 March 2023
+
+#### :hammer_and_wrench: Others
+
+- Prettier [Tiberiu Ichim - [`d2fced6`](https://github.com/eea/volto-globalsearch/commit/d2fced6fb614b7b2dca3ff1425ce33400a085a5d)]
+- removed unused imports [Zoltan Szabo - [`f6d7dc4`](https://github.com/eea/volto-globalsearch/commit/f6d7dc4f787005027a102fb513aa2e8aba5ffba9)]
+- Added 'Publication reference' to the 'Others' cluster [Zoltan Szabo - [`73e289d`](https://github.com/eea/volto-globalsearch/commit/73e289deb8e841610575ff92095506b7279ecbc5)]
+- Refs #241801; Added searchengine with new facet for keywords [Zoltan Szabo - [`654f3ca`](https://github.com/eea/volto-globalsearch/commit/654f3ca1ba79190c721bf200f24808b31c79be8f)]
+### [1.0.11](https://github.com/eea/volto-globalsearch/compare/1.0.10...1.0.11) - 14 February 2023
+
+#### :hammer_and_wrench: Others
+
+- Fix nbame [Tiberiu Ichim - [`57ded54`](https://github.com/eea/volto-globalsearch/commit/57ded54282f232b8598fe9847bc7619ba970c541)]
+- Updated facet names [Zoltan Szabo - [`798f43b`](https://github.com/eea/volto-globalsearch/commit/798f43bcbdbebac3a5566c58f90ee9e394d66354)]
+- Whitespace [Tiberiu Ichim - [`f02946b`](https://github.com/eea/volto-globalsearch/commit/f02946bb03d942b879d0cab1d94ae835ad7207e3)]
+- updated landing page and facets [Zoltan Szabo - [`3d04325`](https://github.com/eea/volto-globalsearch/commit/3d04325df54c5f502f951bc1573cd40eb385b435)]
 ### [1.0.10](https://github.com/eea/volto-globalsearch/compare/1.0.9...1.0.10) - 9 February 2023
 
 #### :hammer_and_wrench: Others

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-globalsearch",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "description": "@eeacms/volto-globalsearch: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",

package/src/config/clusters.js

@@ -59,6 +59,7 @@ export const clusters = {
         'Tool',
         'Case study',
         'External data reference',
+        'Publication reference',
       ], // this will be transformed in "single type clusters".
       defaultResultView: 'horizontalCard',
     },

package/src/config/facets.js

@@ -101,6 +101,15 @@ const facets = [
     showAllOptions: true, // show all options (even if 0) in modal facet
     alwaysVisible: true,
   }),
+  multiTermFacet({
+    field: 'subject.keyword',
+    isFilterable: true,
+    isMulti: true,
+    label: 'Keywords',
+    show: 10000,
+    showAllOptions: true, // show all options (even if 0) in modal facet
+    alwaysVisible: false,
+  }),
   multiTermFacet({
     field: 'spatial',
     isFilterable: true,
@@ -111,7 +120,7 @@ const facets = [
     iconsFamily: 'Countries',
     enableExact: true,
     sortOn: 'value',
-    alwaysVisible: true,
+    alwaysVisible: false,
   }),
   multiTermFacet({
     field: 'op_cluster',
@@ -122,15 +131,24 @@ const facets = [
     showInFacetsList: false,
     ignoreNLPWhenActive: true,
   }),
+  multiTermFacet({
+    field: 'cluster_name',
+    isFilterable: false,
+    isMulti: true,
+    label: 'Websites',
+    iconsFamily: 'Sources',
+    alwaysVisible: true,
+  }),
 
   multiTermFacet({
     field: 'places',
     isFilterable: true,
     isMulti: true,
-    label: 'Regions/Places/Cities/Seas...',
+    label: 'Regions/Places',
     blacklist: placesBlacklist,
     show: 10000,
     showAllOptions: true, // show all options (even if 0) in modal facet
+    alwaysVisible: true,
   }),
   multiTermFacet({
     field: 'objectProvides',
@@ -141,13 +159,6 @@ const facets = [
     //whitelist: objectProvidesWhitelist,
     optionsFilter: 'typesForClustersOptionsFilter',
   }),
-  multiTermFacet({
-    field: 'cluster_name',
-    isFilterable: false,
-    isMulti: true,
-    label: 'Sources',
-    iconsFamily: 'Sources',
-  }),
   histogramFacet({
     field: 'year',
     // isFilterable: false,

package/src/config/global-search-base-config.js

@@ -0,0 +1,120 @@
+import { build_runtime_mappings } from '../utils';
+import clusterParams, { clusters } from './clusters';
+
+import facets from './facets';
+import views from './views';
+import query from './query';
+import filters from './filters';
+import download from './download';
+import vocabs from './vocabulary';
+
+import objectProvidesWhitelist from './json/objectProvidesWhitelist.json';
+import spatialWhitelist from './json/spatialWhitelist.json';
+import placesBlacklist from './json/placesBlacklist.json';
+import typesWhitelist from './json/typesWhitelist.json';
+
+const globalSearchBaseConfig = {
+  title: 'Global search and catalogue',
+  layoutComponent: 'TopFilterLayout',
+  contentBodyComponent: 'FilterAsideContentView',
+  enableNLP: true, // enables NLP capabilities
+  facetsListComponent: 'DropdownFacetsList',
+  runtime_mappings: build_runtime_mappings(clusters),
+  useSearchPhrases: false,
+  searchAsYouType: false,
+  landingPageURL: '/en/advanced-search',
+  getActiveFilters: 'getGlobalSearchActiveFilters',
+
+  ...vocabs,
+  ...facets,
+  ...views,
+  ...query,
+  ...filters,
+  ...download,
+  ...clusterParams,
+
+  sourceExcludedFields: ['embedding'], // don't need these in results
+  // 'fulltext',
+
+  // these are used to "clean" the values in the results.
+  field_filters: {
+    type: {
+      whitelist: typesWhitelist,
+    },
+    objectProvides: {
+      whitelist: objectProvidesWhitelist,
+    },
+    spatial: {
+      whitelist: spatialWhitelist,
+    },
+    places: {
+      blacklist: placesBlacklist,
+    },
+  },
+
+  highlight: {
+    queryParams: {
+      fragment_size: 200,
+      number_of_fragments: 3,
+    },
+    fields: ['description.highlight'],
+    queryBuilder: {
+      factory: 'highlightQueryBuilder',
+    },
+  },
+
+  sortOptions: [
+    {
+      name: 'Title a-z',
+      value: 'title.index',
+      direction: 'asc',
+    },
+    {
+      name: 'Title z-a',
+      value: 'title.index',
+      direction: 'desc',
+    },
+    {
+      name: 'Oldest',
+      value: 'issued.date',
+      direction: 'asc',
+    },
+    {
+      name: 'Newest',
+      value: 'issued.date',
+      direction: 'desc',
+    },
+  ],
+
+  defaultPromptQueries: [
+    'what is the status of our forests',
+    'what is PFAS?',
+    'how does PFAS get into human?',
+    'what is the cumulative surface area of the Natura 2000?',
+    'what percentage of europe population is connected to waste water treatement?',
+    'How is the status of fish species in Europe?',
+    'What is the BISE?',
+    'how much does transport contributes to GHG emissions in EU?',
+    'Which cities in Europe have the worst air quality?',
+    'What car is best for the environment?',
+    'What transport mode is best for the environment?',
+    'What EU legislation safeguards our water?',
+    'What is land accounting?',
+    'What countries had the highest land take in the EEA-39 between 2000 and 2018?',
+    'Why is urban sprawl bad?',
+    'what are controlled substances',
+    'what is plastic',
+    'What year did car manufacturers meet their binding emissions target?',
+    'What is the percentage of surface water bodies with less than good status?',
+    'What is the most common pollutant in water bodies in Europe?',
+    'Where can I access greenhouse gas data',
+    'What is the trend on greenhouse gas emissions from transport',
+    'what is the best transport mode',
+    'what are ecosystem services',
+    'bathing water quality',
+    'greenhouse gas emissions trends',
+    'waste generation trends',
+  ],
+};
+
+export default globalSearchBaseConfig;

package/src/config/global-search-config.js

@@ -1,120 +1,11 @@
-import { build_runtime_mappings } from '../utils';
-import clusterParams, { clusters } from './clusters';
+import cloneDeep from 'lodash.clonedeep';
 
-import facets from './facets';
-import views from './views';
-import query from './query';
-import filters from './filters';
-import download from './download';
-import vocabs from './vocabulary';
+import globalSearchBaseConfig from './global-search-base-config.js';
 
-import objectProvidesWhitelist from './json/objectProvidesWhitelist.json';
-import spatialWhitelist from './json/spatialWhitelist.json';
-import placesBlacklist from './json/placesBlacklist.json';
-import typesWhitelist from './json/typesWhitelist.json';
+let globalSearchConfig = cloneDeep(globalSearchBaseConfig);
 
-const globalSearchConfig = {
-  title: 'Global search and catalogue',
-  layoutComponent: 'TopFilterLayout',
-  contentBodyComponent: 'FilterAsideContentView',
-  enableNLP: true, // enables NLP capabilities
-  facetsListComponent: 'DropdownFacetsList',
-  runtime_mappings: build_runtime_mappings(clusters),
-  useSearchPhrases: false,
-  searchAsYouType: false,
-  landingPageURL: '/en/advanced-search',
-  getActiveFilters: 'getGlobalSearchActiveFilters',
-
-  ...vocabs,
-  ...facets,
-  ...views,
-  ...query,
-  ...filters,
-  ...download,
-  ...clusterParams,
-
-  sourceExcludedFields: ['embedding'], // don't need these in results
-  // 'fulltext',
-
-  // these are used to "clean" the values in the results.
-  field_filters: {
-    type: {
-      whitelist: typesWhitelist,
-    },
-    objectProvides: {
-      whitelist: objectProvidesWhitelist,
-    },
-    spatial: {
-      whitelist: spatialWhitelist,
-    },
-    places: {
-      blacklist: placesBlacklist,
-    },
-  },
-
-  highlight: {
-    queryParams: {
-      fragment_size: 200,
-      number_of_fragments: 3,
-    },
-    fields: ['description.highlight'],
-    queryBuilder: {
-      factory: 'highlightQueryBuilder',
-    },
-  },
-
-  sortOptions: [
-    {
-      name: 'Title a-z',
-      value: 'title.index',
-      direction: 'asc',
-    },
-    {
-      name: 'Title z-a',
-      value: 'title.index',
-      direction: 'desc',
-    },
-    {
-      name: 'Oldest',
-      value: 'issued.date',
-      direction: 'asc',
-    },
-    {
-      name: 'Newest',
-      value: 'issued.date',
-      direction: 'desc',
-    },
-  ],
-
-  defaultPromptQueries: [
-    'what is the status of our forests',
-    'what is PFAS?',
-    'how does PFAS get into human?',
-    'what is the cumulative surface area of the Natura 2000?',
-    'what percentage of europe population is connected to waste water treatement?',
-    'How is the status of fish species in Europe?',
-    'What is the BISE?',
-    'how much does transport contributes to GHG emissions in EU?',
-    'Which cities in Europe have the worst air quality?',
-    'What car is best for the environment?',
-    'What transport mode is best for the environment?',
-    'What EU legislation safeguards our water?',
-    'What is land accounting?',
-    'What countries had the highest land take in the EEA-39 between 2000 and 2018?',
-    'Why is urban sprawl bad?',
-    'what are controlled substances',
-    'what is plastic',
-    'What year did car manufacturers meet their binding emissions target?',
-    'What is the percentage of surface water bodies with less than good status?',
-    'What is the most common pollutant in water bodies in Europe?',
-    'Where can I access greenhouse gas data',
-    'What is the trend on greenhouse gas emissions from transport',
-    'what is the best transport mode',
-    'what are ecosystem services',
-    'bathing water quality',
-    'greenhouse gas emissions trends',
-    'waste generation trends',
-  ],
-};
+globalSearchConfig.facets = globalSearchConfig.facets.filter(
+  (facet) => facet['field'] !== 'subject.keyword',
+);
 
 export default globalSearchConfig;

package/src/config/index.js

@@ -13,6 +13,8 @@ import { UniversalCard } from '@eeacms/volto-listing-block';
 import contentTypeNormalize from './json/contentTypeNormalize.json';
 import globalSearchConfig from './global-search-config.js';
 
+import globalSearchBaseConfig from './global-search-base-config.js';
+
 const getClientProxyAddress = () => {
   const url = new URL(window.location);
   url.pathname = '';
@@ -67,6 +69,11 @@ export default function install(config) {
     host: process.env.RAZZLE_ES_PROXY_ADDR || 'http://localhost:3000',
   };
 
+  config.searchui.globalsearchbase = {
+    ...mergeConfig(globalSearchBaseConfig, config.searchui.default),
+    elastic_index: 'es',
+    host: process.env.RAZZLE_ES_PROXY_ADDR || 'http://localhost:3000',
+  };
   if (typeof window !== 'undefined') {
     config.searchui.globalsearch.host =
       process.env.RAZZLE_ES_PROXY_ADDR || getClientProxyAddress();

package/src/config/views.js

@@ -201,7 +201,7 @@ export default {
         },
         {
           id: 'website',
-          title: 'Sources',
+          title: 'Websites',
           facetField: 'cluster_name',
           sortOn: 'count',
           sortOrder: 'desc',

package/src/index.js

@@ -3,11 +3,14 @@ import installGlobalsearch from './config';
 export default (config) => {
   config.settings.searchlib = installGlobalsearch(config.settings.searchlib);
 
-  const { globalsearch } = config.settings.searchlib.searchui;
+  const { globalsearch, globalsearchbase } = config.settings.searchlib.searchui;
 
   // Tweak the searchlib config to use the middleware instead of the index
   globalsearch.elastic_index = '_es/globalsearch';
   globalsearch.index_name = 'data_searchui';
 
+  globalsearchbase.elastic_index = '_es/globalsearch';
+  globalsearchbase.index_name = 'data_searchui';
+
   return config;
 };

package/src/utils.js

@@ -5,7 +5,7 @@
 //   });
 //   return icons;
 // };
-//
+
 export const build_runtime_mappings = (settings) => {
   const clusters = settings.clusters
     .map((cluster) => {
@@ -62,6 +62,7 @@ export function getTodayWithTime() {
   ].join('');
   return output;
 }
+
 export const getGlobalsearchIconUrl = (contentTypeNormalize) => (
   result,
   config,