@eeacms/volto-globalsearch 1.0.22 → 1.1.0

package/CHANGELOG.md

@@ -4,6 +4,15 @@ 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.1.0](https://github.com/eea/volto-globalsearch/compare/1.0.22...1.1.0) - 16 January 2024
+
+#### :hammer_and_wrench: Others
+
+- Release 1.1.0 [Alin Voinea - [`822ac10`](https://github.com/eea/volto-globalsearch/commit/822ac1049228c132637fd019f233ae7bc63ff9a8)]
+- updated facets [Zoltan Szabo - [`7206aed`](https://github.com/eea/volto-globalsearch/commit/7206aed30bf3a178c4660a4a280821bee5e4a19b)]
+- added facet for publisher [Zoltan Szabo - [`68dc66a`](https://github.com/eea/volto-globalsearch/commit/68dc66a612286a7767bbed289e1743aac23adc4e)]
+- updated default facets config [Zoltan Szabo - [`adbd434`](https://github.com/eea/volto-globalsearch/commit/adbd434c6baedaf98cd3145e75e368c92101758d)]
+- added new facets [Zoltan Szabo - [`acc6ba8`](https://github.com/eea/volto-globalsearch/commit/acc6ba8e4ee8c911343ac129f4ae3fcc99355ff7)]
 ### [1.0.22](https://github.com/eea/volto-globalsearch/compare/1.0.21...1.0.22) - 12 December 2023
 
 #### :house: Internal changes

package/README.md

@@ -76,6 +76,43 @@ Go to http://localhost:3000
 
 1. Happy editing!
 
+# Customizing the volto-searchblock
+
+## Modifying Clusters
+
+To customize the behavior of the `volto-searchblock` in your volto theme addon, you can modify clusters by following these steps:
+
+ 1. Find or create `index.js` in the `src/config`
+
+      In your theme addon, create the `src/config/index.js` file. You can refer to the [example file](https://github.com/eea/volto-marine-theme/blob/eea-design/src/config/index.js) in the `volto-marine-theme` repository.
+
+2. Locate and Modify Clusters
+
+   Clusters are found in `config.searchui.<name_of_search>.runtime_mappings`. For example, in the case of the `volto-marine-theme`, the `<name_of_search>` was `marinemeasure`, and clusters are located in `config.searchui.marinemeasure.runtime_mappings`.
+
+3. Use `build_runtime_mappings`
+   
+   You have to pass the clusters transformed by build_runtime_mappings function. Import the `build_runtime_mappings` as follows:
+
+     ```javascript
+      import { build_runtime_mappings } from '@eeacms/volto-globalsearch/utils';
+     ```
+5. Default Clusters
+
+   Default clusters are defined [here](https://github.com/eea/volto-globalsearch/blob/master/src/config/clusters.js). Decide whether you want to override all clusters or modify specific ones.
+   If you decided to modify them, you can import them in your addon as follows:
+   ```javascript
+   import { clusters } from '@eeacms/volto-globalsearch/config/clusters';
+   ```
+
+6. Example Modification
+
+   Here's an example of how the Publications cluster was modified in the CountryFactsheet by keeping the rest as default: https://github.com/eea/volto-marine-theme/pull/43/files.
+
+7. Cluster Structure
+
+   Be aware that a cluster contains the `values` key that holds the `content types` on which the cluster will act.
+
 ## Release
 
 See [RELEASE.md](https://github.com/eea/volto-globalsearch/blob/master/RELEASE.md).

package/package.json

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

package/src/config/facets.js

@@ -12,6 +12,7 @@ import topicsBlacklist from './json/topicsBlacklist.json';
 import { getTodayWithTime } from '../utils';
 
 const languageCodes = [
+  'en',
   'ar',
   'sr',
   'sq',
@@ -22,7 +23,6 @@ const languageCodes = [
   'da',
   'nl',
   'el',
-  'en',
   'et',
   'fi',
   'fr',
@@ -273,6 +273,58 @@ const facets = [
     facetValues: languageCodes,
     sortOn: 'custom',
     sortOnCustomLabel: 'Alphabetical',
+    sortOrder: 'ascending',
+  }),
+  multiTermFacet({
+    field: 'dpsir.keyword',
+    isFilterable: false,
+    isMulti: true,
+    label: 'DPSIR',
+  }),
+  multiTermFacet({
+    field: 'typology.keyword',
+    isFilterable: false,
+    isMulti: true,
+    label: 'Typology',
+  }),
+  multiTermFacet({
+    field: 'un_sdgs.keyword',
+    isFilterable: false,
+    isMulti: true,
+    label: 'UN SDGs',
+  }),
+  multiTermFacet({
+    field: 'data_provenances_organisations.keyword',
+    isFilterable: true,
+    isMulti: true,
+    label: 'Data sources',
+  }),
+  multiTermFacet({
+    field: 'creators.keyword',
+    isFilterable: true,
+    isMulti: true,
+    label: 'Creators',
+    authOnly: true,
+  }),
+  multiTermFacet({
+    field: 'contributors.keyword',
+    isFilterable: true,
+    isMulti: true,
+    label: 'Contributors',
+  }),
+  multiTermFacet({
+    field: 'subject.keyword_lc',
+    isFilterable: true,
+    isMulti: true,
+    label: 'Tags',
+    sortOn: 'value',
+    sortOrder: 'ascending',
+  }),
+  multiTermFacet({
+    field: 'publishers.keyword',
+    isFilterable: false,
+    isMulti: true,
+    label: 'Publishers',
   }),
 ];