@eeacms/volto-globalsearch 1.0.20 → 1.0.22

package/.eslintignore

@@ -1 +1,2 @@
 src/config/json/*.json
+src/config/healthcheck_queries/*.json

package/.husky/pre-commit

@@ -0,0 +1,2 @@
+[ -n "$CI" ] && exit 0
+yarn lint-staged

package/CHANGELOG.md

@@ -4,6 +4,49 @@ 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.22](https://github.com/eea/volto-globalsearch/compare/1.0.21...1.0.22) - 12 December 2023
+
+#### :house: Internal changes
+
+- chore: husky, lint-staged use fixed versions [valentinab25 - [`866609d`](https://github.com/eea/volto-globalsearch/commit/866609d540bd0efe4bab088305bb2127105d8df7)]
+- chore:volto 16 in tests, update docs, fix stylelint overrides [valentinab25 - [`e09f5e2`](https://github.com/eea/volto-globalsearch/commit/e09f5e2c1161b4b867c04eb1c0421274bd6c7110)]
+
+#### :hammer_and_wrench: Others
+
+- removed try/catch [Zoltan Szabo - [`86cec5d`](https://github.com/eea/volto-globalsearch/commit/86cec5d49d06d41541dc6d42464e9b95769da745)]
+- avoid async promise executor functions [Zoltan Szabo - [`61012e3`](https://github.com/eea/volto-globalsearch/commit/61012e331776fadaa9eafe9f7667b18d08b2351a)]
+### [1.0.21](https://github.com/eea/volto-globalsearch/compare/1.0.20...1.0.21) - 29 September 2023
+
+#### :house: Internal changes
+
+- style: lint-staged reorder in package.json [Alin Voinea - [`06a080f`](https://github.com/eea/volto-globalsearch/commit/06a080f12993015398d29cba5c0629247512833b)]
+
+#### :house: Documentation changes
+
+- docs: Update README and DEVELOP [Alin Voinea - [`decd2dc`](https://github.com/eea/volto-globalsearch/commit/decd2dcc9719917d5718545bc114d6095a9ce2d9)]
+- docs: Update DEVELOP [Alin Voinea - [`63221f1`](https://github.com/eea/volto-globalsearch/commit/63221f15c1ae25f2de80e7fad0fcde98991945ab)]
+
+#### :hammer_and_wrench: Others
+
+- typo [Zoltan Szabo - [`0464524`](https://github.com/eea/volto-globalsearch/commit/0464524e8b956f059903ed1a9b89d25067a31dcb)]
+- added more tests [Zoltan Szabo - [`236e4f2`](https://github.com/eea/volto-globalsearch/commit/236e4f2fbb2931dd3a1dff75b8d41135c5925af3)]
+- added more tests [Zoltan Szabo - [`a46e825`](https://github.com/eea/volto-globalsearch/commit/a46e82505eb9a9b0131da77e3f38b8b22f8bd062)]
+- prettier jsons [Zoltan Szabo - [`b3617b2`](https://github.com/eea/volto-globalsearch/commit/b3617b263262210c38989814f620701012b35fab)]
+- added missing files [Zoltan Szabo - [`9d99b47`](https://github.com/eea/volto-globalsearch/commit/9d99b4791dde155ebaa8746afe3fae76717f110a)]
+- refactor, and updated tests [Zoltan Szabo - [`e8ee669`](https://github.com/eea/volto-globalsearch/commit/e8ee669a99b3827f4b74dc4fba463a22163d2444)]
+- removed debug code [Zoltan Szabo - [`e776630`](https://github.com/eea/volto-globalsearch/commit/e776630d1a6842cc750b6091f9d4692bc47410cb)]
+- added more tests for healthcheck [Zoltan Szabo - [`bb38530`](https://github.com/eea/volto-globalsearch/commit/bb3853004af289a73bf6b5343bac92f4a559cf0d)]
+- added more tests for healthcheck [Zoltan Szabo - [`3254d57`](https://github.com/eea/volto-globalsearch/commit/3254d57f7afac5410f54b86f91ae1257490fa201)]
+- added tests for healthcheck [Zoltan Szabo - [`7d42dfc`](https://github.com/eea/volto-globalsearch/commit/7d42dfc481a3a355d54c2d679f0fb83c702190e8)]
+- made queries prettier [Zoltan Szabo - [`f5b3f1e`](https://github.com/eea/volto-globalsearch/commit/f5b3f1e65108df9b0e5fe749de80cb8a1581e9db)]
+- fixed eslints [Zoltan Szabo - [`c1f0cb5`](https://github.com/eea/volto-globalsearch/commit/c1f0cb52edd363ef8db748d9d7141eac40a8dec6)]
+- test: EN locales, pre-commit fix, feature PRs checks Refs #257193 [valentinab25 - [`a4633e7`](https://github.com/eea/volto-globalsearch/commit/a4633e770e0b4c211dbdda83fe5005bcb74895bd)]
+- updated labels for reading time aggregations [Zoltan Szabo - [`4061905`](https://github.com/eea/volto-globalsearch/commit/4061905d84b38364d5ac8dbf13665b1fb7130969)]
+- i18n: Add en [Alin Voinea - [`3359382`](https://github.com/eea/volto-globalsearch/commit/33593824d993c09ca3530e6fe29d6e4a8770f110)]
+- test: Update Makefile and docker-compose to align it with Jenkinsfile [valentinab25 - [`fcf08e3`](https://github.com/eea/volto-globalsearch/commit/fcf08e34e4cb504bc65233b8cde37dbc5f69efe6)]
+- remove debugger [Zoltan Szabo - [`d8fed25`](https://github.com/eea/volto-globalsearch/commit/d8fed255f24bf3be9d50295906c38b95888baffd)]
+- updated tests [Zoltan Szabo - [`6712800`](https://github.com/eea/volto-globalsearch/commit/6712800eee7cfc9ded4f2eed15ec61f19091eb27)]
+- added new permanent filter, so we can exclude some documents from global search [Zoltan Szabo - [`4a1095b`](https://github.com/eea/volto-globalsearch/commit/4a1095bedc3970ee14728ee1e90b30223e50913e)]
 ### [1.0.20](https://github.com/eea/volto-globalsearch/compare/1.0.19...1.0.20) - 17 August 2023
 
 #### :house: Documentation changes
@@ -34,13 +77,11 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 #### :house: Internal changes
 
-- chore: [JENKINS] Deprecate circularity website [valentinab25 - [`ae6efed`](https://github.com/eea/volto-globalsearch/commit/ae6efed386f8fd053972a388a3f8714ff36cf575)]
 
 #### :hammer_and_wrench: Others
 
 - added missing logo [Zoltan Szabo - [`94684b9`](https://github.com/eea/volto-globalsearch/commit/94684b979698c47de353ecc2a9014a8f70d7ecc1)]
 - updated frontend with configuration for 'Climate Advisory Board' [Zoltan Szabo - [`28cf22c`](https://github.com/eea/volto-globalsearch/commit/28cf22c93237226c3957223b497a33ab3cb73623)]
-- Add Sonarqube tag using cca-frontend addons list [EEA Jenkins - [`b655d51`](https://github.com/eea/volto-globalsearch/commit/b655d51fa3631ae42c89eb85bdcc850f70d9c72c)]
 ### [1.0.15](https://github.com/eea/volto-globalsearch/compare/1.0.14...1.0.15) - 14 March 2023
 
 #### :hammer_and_wrench: Others
@@ -60,7 +101,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 #### :hammer_and_wrench: Others
 
 - set the middleware proxy address for globalsearchbase [Zoltan Szabo - [`d0a0802`](https://github.com/eea/volto-globalsearch/commit/d0a08026fa73ce8fd15b666c922e7db71104a5d1)]
-- Add Sonarqube tag using eea-website-frontend addons list [EEA Jenkins - [`b710a4f`](https://github.com/eea/volto-globalsearch/commit/b710a4f73f61e164ecf502a83e7f07d0daf578b3)]
 ### [1.0.12](https://github.com/eea/volto-globalsearch/compare/1.0.11...1.0.12) - 1 March 2023
 
 #### :hammer_and_wrench: Others
@@ -128,14 +168,12 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Make last 2 years default [Tiberiu Ichim - [`ff765e2`](https://github.com/eea/volto-globalsearch/commit/ff765e24a1d93c60f091aeffa7c3156d8fb98e49)]
 - Add compact listing, placeholder for now [Tiberiu Ichim - [`3f6104f`](https://github.com/eea/volto-globalsearch/commit/3f6104fb1725f7e3c22736a30629f64e4882242a)]
 - test(Jenkins): Run tests and cypress with latest canary @plone/volto [Alin Voinea - [`8120264`](https://github.com/eea/volto-globalsearch/commit/812026495c31b272e6ae6415642cf1a6b2f783cf)]
-- yarn 3 [Alin Voinea - [`b61ad50`](https://github.com/eea/volto-globalsearch/commit/b61ad5075a79bebfce1044a6cd4978c92d98fbdc)]
 ### [1.0.1](https://github.com/eea/volto-globalsearch/compare/1.0.0...1.0.1) - 16 November 2022
 
 #### :hammer_and_wrench: Others
 
 - Fix eslint [Tiberiu Ichim - [`cf2886b`](https://github.com/eea/volto-globalsearch/commit/cf2886b412013f9427cf5d39cdf00004bdd9f80b)]
 - test(estlint): Fix .project.eslintrc.js [Alin Voinea - [`40c08d2`](https://github.com/eea/volto-globalsearch/commit/40c08d2d4eda81ce306225a81f09e0bcfe6794eb)]
-- Add Sonarqube tag using circularity-frontend addons list [EEA Jenkins - [`af6e020`](https://github.com/eea/volto-globalsearch/commit/af6e020794798c1f69fee8c08bdf71fc3992230a)]
 ## [1.0.0](https://github.com/eea/volto-globalsearch/compare/0.1.7...1.0.0) - 28 October 2022
 
 #### :nail_care: Enhancements
@@ -154,7 +192,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 #### :hammer_and_wrench: Others
 
 - Fix dependencies [kreafox - [`50ad307`](https://github.com/eea/volto-globalsearch/commit/50ad307d64140c43df9dded27c0b532923885764)]
-- Add Sonarqube tag using eea-website-frontend addons list [EEA Jenkins - [`c2d848e`](https://github.com/eea/volto-globalsearch/commit/c2d848e1efa456f53d883c50769882101e1ce19f)]
 ### [0.1.5](https://github.com/eea/volto-globalsearch/compare/0.1.4...0.1.5) - 28 July 2022
 
 #### :hammer_and_wrench: Others
@@ -167,7 +204,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 #### :hammer_and_wrench: Others
 
-- Add Sonarqube tag using eea-website-frontend addons list [EEA Jenkins - [`5dce07b`](https://github.com/eea/volto-globalsearch/commit/5dce07ba7d1e82776a426e9746d5dab1b0acf738)]
 ### [0.1.3](https://github.com/eea/volto-globalsearch/compare/0.1.2...0.1.3) - 10 June 2022
 
 ### [0.1.2](https://github.com/eea/volto-globalsearch/compare/0.1.1...0.1.2) - 10 June 2022
@@ -190,7 +226,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - ignore eslint for *.json files [Zoltan Szabo - [`e18919e`](https://github.com/eea/volto-globalsearch/commit/e18919e1255818c5cf33bf769cca078d75ca3422)]
 - formatting [Zoltan Szabo - [`18282ed`](https://github.com/eea/volto-globalsearch/commit/18282ed159865bcbc50e2fd17417cf6d90d3e593)]
 - updated dependencies [Zoltan Szabo - [`cfcf46e`](https://github.com/eea/volto-globalsearch/commit/cfcf46ee33b23bb31f76955c12a857411f042daf)]
-- [JENKINSFILE] fix after bootstrap [valentinab25 - [`61c8c46`](https://github.com/eea/volto-globalsearch/commit/61c8c46891edf3b52768f12cf7505c034ef7bb89)]
 ### 0.0.1 - 19 May 2022
 
 #### :hammer_and_wrench: Others

package/DEVELOP.md

@@ -16,12 +16,14 @@
 
 1. Go to http://localhost:3000
 
-1.  Happy hacking!
+1. Initialize git hooks
 
     ```Bash
-    cd src/addons/volto-globalsearch/
+    yarn prepare
     ```
 
+1. Happy hacking!
+
 ### Or add @eeacms/volto-globalsearch to your Volto project
 
 Before starting make sure your development environment is properly set. See [Volto Developer Documentation](https://docs.voltocms.com/getting-started/install/)
@@ -48,18 +50,15 @@ Before starting make sure your development environment is properly set. See [Vol
 
 1.  Install
 
-        yarn develop
+        make develop
         yarn
 
 1.  Start backend
 
-        docker pull plone
-        docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" plone
+        docker run --pull always -it --rm --name plone -p 8080:8080 -e SITE=Plone plone/plone-backend
 
     ...wait for backend to setup and start - `Ready to handle requests`:
 
-        docker logs -f plone
-
     ...you can also check http://localhost:8080/Plone
 
 1.  Start frontend
@@ -71,7 +70,6 @@ Before starting make sure your development environment is properly set. See [Vol
 1.  Happy hacking!
 
         cd src/addons/volto-globalsearch/
-n-template/
 
 ## Cypress
 

package/README.md

@@ -14,9 +14,12 @@
 [![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-globalsearch-develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-globalsearch-develop)
 [![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-globalsearch-develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-globalsearch-develop)
 
-
 EEA Elastic Search Block with NLP integration [Volto](https://github.com/plone/volto) add-on
 
+## Features
+
+![Globalsearch](https://raw.githubusercontent.com/eea/volto-globalsearch/master/docs/volto-globalsearch.gif)
+
 ## Demo
 
 - https://demo-www.eea.europa.eu/en/advanced-search
@@ -58,7 +61,7 @@ Go to http://localhost:3000
 
    ```
    npm install -g yo @plone/generator-volto
-   yo @plone/volto my-volto-project --addon @eeacms/volto-globalsearch
+   yo @plone/volto my-volto-project --canary --addon @eeacms/volto-globalsearch
    cd my-volto-project
    ```
 

package/RELEASE.md

@@ -20,9 +20,9 @@ You need to first install the [release-it](https://github.com/release-it/release
    ```
    npm install -g release-it
    ```
-   
+
 Release-it uses the configuration written in the [`.release-it.json`](./.release-it.json) file located in the root of the repository.
-   
+
 Release-it is a tool that automates 4 important steps in the release process:
 
 1. Version increase in `package.json` ( increased from the current version in `package.json`)
@@ -30,45 +30,45 @@ Release-it is a tool that automates 4 important steps in the release process:
 3. GitHub release on the commit with the changelog and package.json modification on the develop branch
 4. NPM release ( by default it's disabled, but can be enabled in the configuration file )
 
-To configure the authentification, you need to export GITHUB_TOKEN for [GitHub](https://github.com/settings/tokens) 
+To configure the authentification, you need to export GITHUB_TOKEN for [GitHub](https://github.com/settings/tokens)
 
    ```
    export GITHUB_TOKEN=XXX-XXXXXXXXXXXXXXXXXXXXXX
    ```
- 
+
  To configure npm, you can use the `npm login` command or use a configuration file with a TOKEN :
- 
+
    ```
    echo "//registry.npmjs.org/:_authToken=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYY" > .npmrc
    ```
 
 #### Using release-it tool
-  
+
 There are 3 yarn scripts that can be run to do the release
 
 ##### yarn release-beta
 
-Automatically calculates and presents 3 beta versions - patch, minor and major for you to choose ( or Other for manual input). 
+Automatically calculates and presents 3 beta versions - patch, minor and major for you to choose ( or Other for manual input).
 
 ```
-? Select increment (next version): 
-❯ prepatch (0.1.1-beta.0) 
-  preminor (0.2.0-beta.0) 
-  premajor (1.0.0-beta.0) 
-  Other, please specify... 
+? Select increment (next version):
+❯ prepatch (0.1.1-beta.0)
+  preminor (0.2.0-beta.0)
+  premajor (1.0.0-beta.0)
+  Other, please specify...
 ```
 
 ##### yarn release-major-beta
 
 Same as `yarn release-beta`, but with premajor version pre-selected.
-    
+
 ##### yarn release
 
 Generic command, does not automatically add the `beta` to version, but you can still manually write it if you choose Other.
 
 #### Important notes
 
-> Do not use release-it tool on master branch, the commit on CHANGELOG.md file and the version increase in the package.json file can't be done without a PULL REQUEST.  
+> Do not use release-it tool on master branch, the commit on CHANGELOG.md file and the version increase in the package.json file can't be done without a PULL REQUEST.
 
 > Do not keep Pull Requests from develop to master branches open when you are doing beta releases from the develop branch. As long as a PR to master is open, an automatic script will run on every commit and will update both the version and the changelog to a production-ready state - ( MAJOR.MINOR.PATCH mandatory format for version).
 

package/cypress.config.js

@@ -5,9 +5,9 @@ module.exports = defineConfig({
   defaultCommandTimeout: 8888,
   chromeWebSecurity: false,
   reporter: 'junit',
-  video: true,
+  video: false,
   retries: {
-    runMode: 8,
+    runMode: 2,
     openMode: 0,
   },
   reporterOptions: {

package/docker-compose.yml

@@ -1,11 +1,12 @@
 version: "3"
 services:
   backend:
-    image: plone/plone-backend:${PLONE_VERSION:-6}
+    image: eeacms/plone-backend
     ports:
       - "8080:8080"
     environment:
       SITE: "Plone"
+      PROFILES: "eea.kitkat:testing"
 
   frontend: 
     build:
@@ -23,6 +24,9 @@ services:
     volumes:
       - ./:/app/src/addons/${ADDON_PATH}
     environment:
+      CI: "true"
+      NODE_ENV: "development"
+      RAZZLE_JEST_CONFIG: "src/addons/${ADDON_PATH}/jest-addon.config.js"
       RAZZLE_INTERNAL_API_PATH: "http://backend:8080/Plone"
       RAZZLE_DEV_PROXY_API_PATH: "http://backend:8080/Plone"
       HOST: "0.0.0.0"

package/locales/en/LC_MESSAGES/volto.po

@@ -0,0 +1,14 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: \n"
+"PO-Revision-Date: \n"
+"Last-Translator: \n"
+"Language: \n"
+"Language-Team: \n"
+"Content-Type: \n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-globalsearch",
-  "version": "1.0.20",
+  "version": "1.0.22",
   "description": "@eeacms/volto-globalsearch: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",
@@ -28,8 +28,31 @@
     "@cypress/code-coverage": "^3.10.0",
     "@plone/scripts": "*",
     "babel-plugin-transform-class-properties": "^6.24.1",
+    "husky": "^8.0.3",
+    "lint-staged": "^14.0.1",
     "md5": "^2.3.0"
   },
+  "lint-staged": {
+    "src/**/*.{js,jsx,ts,tsx,json}": [
+      "make lint-fix",
+      "make prettier-fix"
+    ],
+    "src/**/*.{jsx}": [
+      "make i18n"
+    ],
+    "theme/**/*.{css,less}": [
+      "make stylelint-fix"
+    ],
+    "src/**/*.{css,less}": [
+      "make stylelint-fix"
+    ],
+    "theme/**/*.overrides": [
+      "make stylelint-fix"
+    ],
+    "src/**/*.overrides": [
+      "make stylelint-fix"
+    ]
+  },
   "scripts": {
     "release": "release-it",
     "release-major-beta": "release-it major --preRelease=beta",
@@ -47,6 +70,7 @@
     "lint:fix": "make lint-fix",
     "i18n": "make i18n",
     "cypress:run": "make cypress-run",
-    "cypress:open": "make cypress-open"
+    "cypress:open": "make cypress-open",
+    "prepare": "husky install"
   }
 }

package/src/config/facets.js

@@ -223,7 +223,7 @@ const facets = [
       { from: 0, to: 4.99999, key: 'Short (<5 minutes)' },
       { from: 5, to: 24.9999, key: 'Medium (5-25 minutes)' },
       { from: 25, to: 10000, key: 'Large (25+ minutes)' },
-      //        { to: -0.0001, key: 'Unknown' },
+      { to: -0.0001, key: 'Not applicable' },
     ],
     // factory: 'ModalFixedRangeFacet',
     default: {

package/src/config/filters.js

@@ -1,30 +1,34 @@
 import { getTodayWithTime } from '../utils';
-
-export default {
-  // filter values that are always added to the ES requests
-  permanentFilters: [
-    { term: { hasWorkflowState: 'published' } },
-    () => ({
-      constant_score: {
-        filter: {
-          bool: {
-            should: [
-              {
-                bool: {
-                  must_not: {
-                    exists: {
-                      field: 'issued',
-                    },
+function constantScore() {
+  return {
+    constant_score: {
+      filter: {
+        bool: {
+          should: [
+            {
+              bool: {
+                must_not: {
+                  exists: {
+                    field: 'issued',
                   },
                 },
               },
-              {
-                range: { 'issued.date': { lte: getTodayWithTime() } },
-              },
-            ],
-          },
+            },
+            {
+              range: { 'issued.date': { lte: getTodayWithTime() } },
+            },
+          ],
         },
       },
-    }),
+    },
+  };
+}
+constantScore.id = 'constantScore';
+
+export default {
+  // filter values that are always added to the ES requests
+  permanentFilters: [
+    { term: { hasWorkflowState: 'published' } },
+    constantScore,
   ],
 };

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

@@ -9,4 +9,24 @@ globalSearchConfig.facets = globalSearchConfig.facets.filter(
   (facet) => facet['field'] !== 'subject.keyword',
 );
 
+// customize permanent filters
+const index = globalSearchConfig.permanentFilters.findIndex(
+  (f) => f.id === 'constantScore',
+);
+const baseConstantScore = globalSearchConfig.permanentFilters[index];
+
+function updatedConstantScore() {
+  const base = baseConstantScore();
+  base.constant_score.filter.bool.must_not = {
+    exists: {
+      field: 'exclude_from_globalsearch',
+    },
+  };
+  return base;
+}
+
+updatedConstantScore.id = 'constantScore';
+
+globalSearchConfig.permanentFilters[index] = updatedConstantScore;
+
 export default globalSearchConfig;