@eeacms/volto-globalsearch 1.1.0 → 2.0.0

package/.eslintrc.js

@@ -0,0 +1,65 @@
+const fs = require('fs');
+const path = require('path');
+const projectRootPath = fs.realpathSync(__dirname + '/../../../');
+
+let voltoPath = path.join(projectRootPath, 'node_modules/@plone/volto');
+let configFile;
+if (fs.existsSync(`${projectRootPath}/tsconfig.json`))
+  configFile = `${projectRootPath}/tsconfig.json`;
+else if (fs.existsSync(`${projectRootPath}/jsconfig.json`))
+  configFile = `${projectRootPath}/jsconfig.json`;
+
+if (configFile) {
+  const jsConfig = require(configFile).compilerOptions;
+  const pathsConfig = jsConfig.paths;
+  if (pathsConfig['@plone/volto'])
+    voltoPath = `./${jsConfig.baseUrl}/${pathsConfig['@plone/volto'][0]}`;
+}
+
+const AddonConfigurationRegistry = require(`${voltoPath}/addon-registry.js`);
+const reg = new AddonConfigurationRegistry(projectRootPath);
+
+// Extends ESlint configuration for adding the aliases to `src` directories in Volto addons
+const addonAliases = Object.keys(reg.packages).map((o) => [
+  o,
+  reg.packages[o].modulePath,
+]);
+
+const addonExtenders = reg.getEslintExtenders().map((m) => require(m));
+
+const defaultConfig = {
+  extends: `${voltoPath}/.eslintrc`,
+  settings: {
+    'import/resolver': {
+      alias: {
+        map: [
+          ['@plone/volto', '@plone/volto/src'],
+          ['@plone/volto-slate', '@plone/volto/packages/volto-slate/src'],
+          ...addonAliases,
+          ['@package', `${__dirname}/src`],
+          ['@root', `${__dirname}/src`],
+          ['~', `${__dirname}/src`],
+        ],
+        extensions: ['.js', '.jsx', '.json'],
+      },
+      'babel-plugin-root-import': {
+        rootPathSuffix: 'src',
+      },
+    },
+  },
+  rules: {
+    'react/jsx-no-target-blank': [
+      'error',
+      {
+        allowReferrer: true,
+      },
+    ],
+  }
+};
+
+const config = addonExtenders.reduce(
+  (acc, extender) => extender.modify(acc),
+  defaultConfig,
+);
+
+module.exports = config;

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).
 
+### [2.0.0](https://github.com/eea/volto-globalsearch/compare/1.1.0...2.0.0) - 22 April 2024
+
+#### :rocket: New Features
+
+- feat: Release 2.0.0 - Volto 17 support [alin - [`3b0dfda`](https://github.com/eea/volto-globalsearch/commit/3b0dfda9e0801c52509f81c285f2e531ef0787d1)]
+- feat: Volto 17 support - refs #264527 [EEA Jenkins - [`ebfe19f`](https://github.com/eea/volto-globalsearch/commit/ebfe19fb45f303647810c850891165182d5e64be)]
+
+#### :hammer_and_wrench: Others
+
 ### [1.1.0](https://github.com/eea/volto-globalsearch/compare/1.0.22...1.1.0) - 16 January 2024
 
 #### :hammer_and_wrench: Others

package/jest-addon.config.js

@@ -1,3 +1,5 @@
+require('dotenv').config({ path: __dirname + '/.env' });
+
 module.exports = {
   testMatch: ['**/src/addons/**/?(*.)+(spec|test).[jt]s?(x)'],
   collectCoverageFrom: [
@@ -9,20 +11,27 @@ module.exports = {
     '@plone/volto/cypress': '<rootDir>/node_modules/@plone/volto/cypress',
     '@plone/volto/babel': '<rootDir>/node_modules/@plone/volto/babel',
     '@plone/volto/(.*)$': '<rootDir>/node_modules/@plone/volto/src/$1',
-    '@package/(.*)$': '<rootDir>/src/$1',
-    '@root/(.*)$': '<rootDir>/src/$1',
+    '@package/(.*)$': '<rootDir>/node_modules/@plone/volto/src/$1',
+    '@root/(.*)$': '<rootDir>/node_modules/@plone/volto/src/$1',
     '@plone/volto-quanta/(.*)$': '<rootDir>/src/addons/volto-quanta/src/$1',
+    '@eeacms/search/(.*)$':
+      '<rootDir>/node_modules/@eeacms/volto-searchlib/src/$1',
     '@eeacms/search': '<rootDir>/node_modules/@eeacms/volto-searchlib/src',
     '@eeacms/(.*?)/(.*)$': '<rootDir>/node_modules/@eeacms/$1/src/$2',
-    '@plone/volto-slate':
+    '@plone/volto-slate$':
       '<rootDir>/node_modules/@plone/volto/packages/volto-slate/src',
+    '@plone/volto-slate/(.*)$':
+      '<rootDir>/node_modules/@plone/volto/packages/volto-slate/src/$1',
     '~/(.*)$': '<rootDir>/src/$1',
     'load-volto-addons':
       '<rootDir>/node_modules/@plone/volto/jest-addons-loader.js',
   },
-  transformIgnorePatterns: ['node_modules/(?!@eeacms)/volto-listing-block'],
+  transformIgnorePatterns: [
+    '/node_modules/(?!(@plone|@root|@package|@eeacms)/).*/',
+  ],
   transform: {
     '^.+\\.js(x)?$': 'babel-jest',
+    '^.+\\.ts(x)?$': 'babel-jest',
     '^.+\\.(png)$': 'jest-file',
     '^.+\\.(jpg)$': 'jest-file',
     '^.+\\.(svg)$': './node_modules/@plone/volto/jest-svgsystem-transform.js',
@@ -35,4 +44,9 @@ module.exports = {
       statements: 5,
     },
   },
+  ...(process.env.JEST_USE_SETUP === 'ON' && {
+    setupFilesAfterEnv: [
+      '<rootDir>/node_modules/@eeacms/volto-globalsearch/jest.setup.js',
+    ],
+  }),
 };

package/jest.setup.js

@@ -0,0 +1,65 @@
+import { jest } from '@jest/globals';
+import configureStore from 'redux-mock-store';
+import thunk from 'redux-thunk';
+import { blocksConfig } from '@plone/volto/config/Blocks';
+import installSlate from '@plone/volto-slate/index';
+
+var mockSemanticComponents = jest.requireActual('semantic-ui-react');
+var mockComponents = jest.requireActual('@plone/volto/components');
+var config = jest.requireActual('@plone/volto/registry').default;
+
+config.blocks.blocksConfig = {
+  ...blocksConfig,
+  ...config.blocks.blocksConfig,
+};
+
+jest.doMock('semantic-ui-react', () => ({
+  __esModule: true,
+  ...mockSemanticComponents,
+  Popup: ({ content, trigger }) => {
+    return (
+      <div className="popup">
+        <div className="trigger">{trigger}</div>
+        <div className="content">{content}</div>
+      </div>
+    );
+  },
+}));
+
+jest.doMock('@plone/volto/components', () => {
+  return {
+    __esModule: true,
+    ...mockComponents,
+    SidebarPortal: ({ children }) => <div id="sidebar">{children}</div>,
+  };
+});
+
+jest.doMock('@plone/volto/registry', () =>
+  [installSlate].reduce((acc, apply) => apply(acc), config),
+);
+
+const mockStore = configureStore([thunk]);
+
+global.fetch = jest.fn(() =>
+  Promise.resolve({
+    json: () => Promise.resolve({}),
+  }),
+);
+
+global.store = mockStore({
+  intl: {
+    locale: 'en',
+    messages: {},
+    formatMessage: jest.fn(),
+  },
+  content: {
+    create: {},
+    subrequests: [],
+  },
+  connected_data_parameters: {},
+  screen: {
+    page: {
+      width: 768,
+    },
+  },
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-globalsearch",
-  "version": "1.1.0",
+  "version": "2.0.0",
   "description": "@eeacms/volto-globalsearch: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",
@@ -28,6 +28,7 @@
     "@cypress/code-coverage": "^3.10.0",
     "@plone/scripts": "*",
     "babel-plugin-transform-class-properties": "^6.24.1",
+    "dotenv": "^16.3.2",
     "husky": "^8.0.3",
     "lint-staged": "^14.0.1",
     "md5": "^2.3.0"

package/src/components/MasonryLandingPage.jsx

@@ -200,9 +200,10 @@ const LandingPage = (props) => {
       landingDataAggs.aggregations.organisations.buckets.length;
     const topics = landingDataAggs.aggregations.topics.buckets.length;
     const languages = landingDataAggs.aggregations.languages.buckets.length;
-    const content_types = landingDataAggs.aggregations.content_types.buckets.filter(
-      (bucket) => objectProvidesWhitelist.indexOf(bucket.key) !== -1,
-    ).length;
+    const content_types =
+      landingDataAggs.aggregations.content_types.buckets.filter(
+        (bucket) => objectProvidesWhitelist.indexOf(bucket.key) !== -1,
+      ).length;
     const countries = landingDataAggs.aggregations.countries.buckets.filter(
       (bucket) => spatialWhitelist.indexOf(bucket.key) !== -1,
     ).length;

package/src/config/clusters.js

@@ -70,7 +70,7 @@ export const clusters = {
 
 export const clusterIcons = get_cluster_icons(clusters);
 
-export default {
+const config = {
   icons: {
     'Content types': get_cluster_icons_dict(clusters),
     Sources: {
@@ -168,6 +168,8 @@ export default {
   },
 };
 
+export default config;
+
 export function typesForClustersOptionsFilter(options, filters) {
   // Only display content types that belong to the currently selected cluster
   const clusterMap = Object.assign(

package/src/config/download.js

@@ -1,4 +1,4 @@
-export default {
+const download = {
   download_fields: [
     {
       field: 'about',
@@ -18,3 +18,5 @@ export default {
     },
   ],
 };
+
+export default download;

package/src/config/facets.js

@@ -328,10 +328,12 @@ const facets = [
   }),
 ];
 
-export default {
+const facetsWrapper = {
   facets,
 };
 
+export default facetsWrapper;
+
 // default filter values
 // TODO: this needs to be removed and the configuration plugged into each of
 // the facets

package/src/config/filters.js

@@ -25,10 +25,12 @@ function constantScore() {
 }
 constantScore.id = 'constantScore';
 
-export default {
+const filters = {
   // filter values that are always added to the ES requests
   permanentFilters: [
     { term: { hasWorkflowState: 'published' } },
     constantScore,
   ],
 };
+
+export default filters;

package/src/config/index.js

@@ -112,12 +112,10 @@ export default function install(config) {
 
   config.resolve.getGlobalSearchHealthcheck = healthcheck;
 
-  config.resolve.getGlobalsearchIconUrl = getGlobalsearchIconUrl(
-    contentTypeNormalize,
-  );
-  config.resolve.getGlobalsearchThumbUrl = getGlobalsearchThumbUrl(
-    contentTypeNormalize,
-  );
+  config.resolve.getGlobalsearchIconUrl =
+    getGlobalsearchIconUrl(contentTypeNormalize);
+  config.resolve.getGlobalsearchThumbUrl =
+    getGlobalsearchThumbUrl(contentTypeNormalize);
 
   config.resolve.typesForClustersOptionsFilter = typesForClustersOptionsFilter;
 

package/src/config/query.js

@@ -1,4 +1,4 @@
-export default {
+const query = {
   debugQuery: false,
   extraQueryParams: {
     text_fields: [
@@ -42,3 +42,5 @@ export default {
   //   ],
   // },
 };
+
+export default query;

package/src/config/views.js

@@ -1,6 +1,6 @@
 import { clusterIcons } from './clusters';
 
-export default {
+const views = {
   resultViews: [
     {
       id: 'horizontalCard',
@@ -274,3 +274,5 @@ export default {
     ],
   },
 };
+
+export default views;

package/src/config/vocabulary.js

@@ -60,4 +60,6 @@ const vocab = {
   },
 };
 
-export default { vocab };
+const vocabWrapper = { vocab };
+
+export default vocabWrapper;

package/src/index.js

@@ -1,6 +1,6 @@
 import installGlobalsearch from './config';
 
-export default (config) => {
+const config = (config) => {
   config.settings.searchlib = installGlobalsearch(config.settings.searchlib);
 
   const { globalsearch, globalsearchbase } = config.settings.searchlib.searchui;
@@ -14,3 +14,5 @@ export default (config) => {
 
   return config;
 };
+
+export default config;

package/src/utils.js

@@ -63,158 +63,154 @@ export function getTodayWithTime() {
   return output;
 }
 
-export const getGlobalsearchIconUrl = (contentTypeNormalize) => (
-  result,
-  config,
-  fallback,
-) => {
-  let image = fallback;
-  let has_img = false;
-  if (
-    result.about.raw.startsWith('http://www.eea.europa.eu/help/glossary/') ||
-    result.about.raw.startsWith('https://www.eea.europa.eu/help/glossary/')
-  ) {
-    image = 'https://www.eea.europa.eu/portal_depiction/term/image_thumb';
-    has_img = true;
-  }
-  if (
-    result.objectProvides &&
-    result.objectProvides.raw.indexOf('Country profile') !== -1
-  ) {
-    image =
-      'https://www.eea.europa.eu/portal_depiction/country-profile/image_thumb';
-    has_img = true;
-  }
-  if (
-    result.about &&
-    result.about.raw.indexOf('://land.copernicus.eu') !== -1
-  ) {
-    image = 'https://www.eea.europa.eu/portal_depiction/data/image_thumb';
-    has_img = true;
-  } else {
-    if (!has_img) {
-      let contentTypes = contentTypeNormalize;
-      let _type;
-      let _typeClass;
-      let _contentType = 'generic';
+export const getGlobalsearchIconUrl =
+  (contentTypeNormalize) => (result, config, fallback) => {
+    let image = fallback;
+    let has_img = false;
+    if (
+      result.about.raw.startsWith('http://www.eea.europa.eu/help/glossary/') ||
+      result.about.raw.startsWith('https://www.eea.europa.eu/help/glossary/')
+    ) {
+      image = 'https://www.eea.europa.eu/portal_depiction/term/image_thumb';
+      has_img = true;
+    }
+    if (
+      result.objectProvides &&
+      result.objectProvides.raw.indexOf('Country profile') !== -1
+    ) {
+      image =
+        'https://www.eea.europa.eu/portal_depiction/country-profile/image_thumb';
+      has_img = true;
+    }
+    if (
+      result.about &&
+      result.about.raw.indexOf('://land.copernicus.eu') !== -1
+    ) {
+      image = 'https://www.eea.europa.eu/portal_depiction/data/image_thumb';
+      has_img = true;
+    } else {
+      if (!has_img) {
+        let contentTypes = contentTypeNormalize;
+        let _type;
+        let _typeClass;
+        let _contentType = 'generic';
 
-      if (!result.objectProvides) {
-        return image;
-      }
+        if (!result.objectProvides) {
+          return image;
+        }
 
-      if (!Array.isArray(result.objectProvides?.raw)) {
-        result.objectProvides.raw = [result.objectProvides.raw];
-      }
-      if (result.objectProvides?.raw?.length > 0) {
-        var pos = result.objectProvides.raw.length - 1;
-        while (true) {
-          _type = result.objectProvides.raw[pos];
-          _typeClass = _type.toLowerCase().replace(/\s/g, '-');
-          if (contentTypes[_typeClass]) {
-            _contentType = contentTypes[_typeClass];
-            break;
-          }
-          pos--;
-          if (pos < 0) {
-            break;
+        if (!Array.isArray(result.objectProvides?.raw)) {
+          result.objectProvides.raw = [result.objectProvides.raw];
+        }
+        if (result.objectProvides?.raw?.length > 0) {
+          var pos = result.objectProvides.raw.length - 1;
+          while (true) {
+            _type = result.objectProvides.raw[pos];
+            _typeClass = _type.toLowerCase().replace(/\s/g, '-');
+            if (contentTypes[_typeClass]) {
+              _contentType = contentTypes[_typeClass];
+              break;
+            }
+            pos--;
+            if (pos < 0) {
+              break;
+            }
           }
         }
+        image =
+          'https://www.eea.europa.eu/portal_depiction/' +
+          _contentType +
+          '/image_thumb';
       }
-      image =
-        'https://www.eea.europa.eu/portal_depiction/' +
-        _contentType +
-        '/image_thumb';
     }
-  }
 
-  return image;
-};
+    return image;
+  };
 
-export const getGlobalsearchThumbUrl = (contentTypeNormalize) => (
-  result,
-  config,
-  fallback,
-) => {
-  let image = fallback;
-  let has_img = false;
-  if (result.site_id?.raw === 'sdi' && result['overview.url']) {
-    has_img = false;
-    /*    if (!Array.isArray(result['overview.url']?.raw)) {
+export const getGlobalsearchThumbUrl =
+  (contentTypeNormalize) => (result, config, fallback) => {
+    let image = fallback;
+    let has_img = false;
+    if (result.site_id?.raw === 'sdi' && result['overview.url']) {
+      has_img = false;
+      /*    if (!Array.isArray(result['overview.url']?.raw)) {
       result['overview.url'].raw = [result['overview.url']?.raw];
     }
     if (result['overview.url']?.raw.length > 0) {
       image = result['overview.url']?.raw[0];
     }
     has_img = true;*/
-  }
-  if (
-    result.about?.raw?.startsWith('http://www.eea.europa.eu/help/glossary/') ||
-    result.about?.raw?.startsWith('https://www.eea.europa.eu/help/glossary/')
-  ) {
-    image = 'https://www.eea.europa.eu/portal_depiction/term/image_preview';
-    has_img = true;
-  }
-  if (result.objectProvides?.raw?.indexOf('Country profile') !== -1) {
-    image =
-      'https://www.eea.europa.eu/portal_depiction/country-profile/image_preview';
-    has_img = true;
-  }
-  if (result.about?.raw?.indexOf('://land.copernicus.eu') !== -1) {
-    image = result?.about?.raw + '/image_preview';
-    has_img = true;
-  }
-  if (
-    result.about?.raw?.indexOf('://biodiversity.europa.eu') !== -1 ||
-    result.about?.raw?.indexOf('://forest.eea.europa.eu') !== -1 ||
-    result.about?.raw?.indexOf('://climate-energy.eea.europa.eu') !== -1 ||
-    result.about?.raw?.indexOf('://industry.eea.europa.eu') !== -1 ||
-    result.about?.raw?.indexOf('://www.eea.europa.eu/en/') !== -1
-  ) {
-    if (result.image_preview) {
-      image = result.image_preview.raw;
+    }
+    if (
+      result.about?.raw?.startsWith(
+        'http://www.eea.europa.eu/help/glossary/',
+      ) ||
+      result.about?.raw?.startsWith('https://www.eea.europa.eu/help/glossary/')
+    ) {
+      image = 'https://www.eea.europa.eu/portal_depiction/term/image_preview';
+      has_img = true;
+    }
+    if (result.objectProvides?.raw?.indexOf('Country profile') !== -1) {
+      image =
+        'https://www.eea.europa.eu/portal_depiction/country-profile/image_preview';
       has_img = true;
     }
-  }
-  if (
-    (result.about?.raw?.startsWith('http://www.eea.europa.eu') ||
-      result.about?.raw?.startsWith('https://www.eea.europa.eu')) &&
-    result.about?.raw?.indexOf('://www.eea.europa.eu/en/') === -1
-  ) {
-    image = result.about.raw + '/image_preview';
-    has_img = true;
-  } else {
-    if (!has_img) {
-      let contentTypes = contentTypeNormalize;
-      let _type;
-      let _typeClass;
-      let _contentType = 'generic';
-      if (!Array.isArray(result.objectProvides?.raw)) {
-        result.objectProvides.raw = [result.objectProvides.raw];
+    if (result.about?.raw?.indexOf('://land.copernicus.eu') !== -1) {
+      image = result?.about?.raw + '/image_preview';
+      has_img = true;
+    }
+    if (
+      result.about?.raw?.indexOf('://biodiversity.europa.eu') !== -1 ||
+      result.about?.raw?.indexOf('://forest.eea.europa.eu') !== -1 ||
+      result.about?.raw?.indexOf('://climate-energy.eea.europa.eu') !== -1 ||
+      result.about?.raw?.indexOf('://industry.eea.europa.eu') !== -1 ||
+      result.about?.raw?.indexOf('://www.eea.europa.eu/en/') !== -1
+    ) {
+      if (result.image_preview) {
+        image = result.image_preview.raw;
+        has_img = true;
       }
-      if (result.objectProvides.raw.length > 0) {
-        var pos = result.objectProvides.raw.length - 1;
-        while (true) {
-          _type = result.objectProvides.raw[pos];
-          _typeClass = _type.toLowerCase().replace(/\s/g, '-');
-          if (contentTypes[_typeClass]) {
-            _contentType = contentTypes[_typeClass];
-            break;
-          }
-          pos--;
-          if (pos < 0) {
-            break;
+    }
+    if (
+      (result.about?.raw?.startsWith('http://www.eea.europa.eu') ||
+        result.about?.raw?.startsWith('https://www.eea.europa.eu')) &&
+      result.about?.raw?.indexOf('://www.eea.europa.eu/en/') === -1
+    ) {
+      image = result.about.raw + '/image_preview';
+      has_img = true;
+    } else {
+      if (!has_img) {
+        let contentTypes = contentTypeNormalize;
+        let _type;
+        let _typeClass;
+        let _contentType = 'generic';
+        if (!Array.isArray(result.objectProvides?.raw)) {
+          result.objectProvides.raw = [result.objectProvides.raw];
+        }
+        if (result.objectProvides.raw.length > 0) {
+          var pos = result.objectProvides.raw.length - 1;
+          while (true) {
+            _type = result.objectProvides.raw[pos];
+            _typeClass = _type.toLowerCase().replace(/\s/g, '-');
+            if (contentTypes[_typeClass]) {
+              _contentType = contentTypes[_typeClass];
+              break;
+            }
+            pos--;
+            if (pos < 0) {
+              break;
+            }
           }
         }
+        image =
+          'https://www.eea.europa.eu/portal_depiction/' +
+          _contentType +
+          '/image_preview';
       }
-      image =
-        'https://www.eea.europa.eu/portal_depiction/' +
-        _contentType +
-        '/image_preview';
     }
-  }
 
-  return image;
-};
+    return image;
+  };
 
 export const get_cluster_icons = (settings) => {
   const icons = {

package/.project.eslintrc.js

@@ -1,53 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-const projectRootPath = fs.existsSync('./project')
-  ? fs.realpathSync('./project')
-  : fs.realpathSync('./../../../');
-const packageJson = require(path.join(projectRootPath, 'package.json'));
-const jsConfig = require(path.join(projectRootPath, 'jsconfig.json'))
-  .compilerOptions;
-
-const pathsConfig = jsConfig.paths;
-
-let voltoPath = path.join(projectRootPath, 'node_modules/@plone/volto');
-
-Object.keys(pathsConfig).forEach((pkg) => {
-  if (pkg === '@plone/volto') {
-    voltoPath = `./${jsConfig.baseUrl}/${pathsConfig[pkg][0]}`;
-  }
-});
-const AddonConfigurationRegistry = require(`${voltoPath}/addon-registry.js`);
-const reg = new AddonConfigurationRegistry(projectRootPath);
-
-// Extends ESlint configuration for adding the aliases to `src` directories in Volto addons
-const addonAliases = Object.keys(reg.packages).map((o) => [
-  o,
-  reg.packages[o].modulePath,
-]);
-
-const voltoSearchlibPath = path.dirname(
-  reg.packages['@eeacms/volto-searchlib'].modulePath,
-);
-const searchlibPath = path.resolve(`${voltoSearchlibPath}/searchlib`);
-
-module.exports = {
-  extends: `${projectRootPath}/node_modules/@plone/volto/.eslintrc`,
-  settings: {
-    'import/resolver': {
-      alias: {
-        map: [
-          ['@plone/volto', '@plone/volto/src'],
-          ...addonAliases,
-          ['@eeacms/search', searchlibPath],
-          ['@package', `${__dirname}/src`],
-          ['~', `${__dirname}/src`],
-        ],
-        extensions: ['.js', '.jsx', '.json'],
-      },
-      'babel-plugin-root-import': {
-        rootPathSuffix: 'src',
-      },
-    },
-  },
-};