npm.io
6.0.0 • Published 6h ago

@eeacms/volto-corsproxy

Licence
MIT
Version
6.0.0
Deps
0
Size
41 kB
Vulns
0
Weekly
0
Stars
3

@eeacms/volto-corsproxy

Releases Pipeline Coverage

Volto add-on

Features

This package enables fetching data from third-party servers through the Volto HTTP server, this way bypassing any CORS security restrictions imposed by the browser.

The way it does this is by providing a pass-through CORS proxy server on the path (configurable) /cors-proxy path. For example, any requests made to the URL http://localhost:3000/cors-proxy/http://example.com/ will be piped to the http://example.com website, through the Volto node server.

As you wouldn't want to provide an open proxy, all proxied destinations need to be configured either via settings.allowed_cors_destinations (which takes a list of hostnames) or an environment variable called RAZZLE_ALLOWED_CORS_DESTINATIONS (where you need to provide a comma-separated list of hostnames).

For example:

settings.allowed_cors_destinations = ['eea.europa.eu', 'plone.org']

or:

RAZZLE_ALLOWED_CORS_DESTINATIONS=eea.europa.eu,plone.org yarn start

As a convenience feature for dealing with third-party API endpoints, there's a new action available, getProxiedExternalContent, somewhat similar to Volto's getContent. Call it like: getProxiedExternalContent(thirdpartyurl) and it will make that async content available in the Redux content reducer, at store.content.subrequests[thirdpartyurl].

Upgrade

Upgrading to 6.x

This version requires Volto 18 or Volto 19 and Node.js 22.

The add-on keeps the same API, so upgrading from 5.x on Volto 18 needs no code changes. The release adds Volto 19 support and moves the repository to the Volto 19 layout, where the published package lives in packages/volto-corsproxy.

Breaking changes
  • Node.js 22 or newer is required (engines.node >= 22), 5.x declared no engine.
  • React 18 is required. The package declares react and react-dom as ^18.2.0 peers, 5.x declared no peers.
  • The package no longer ships the Jest setup. jest-addon.config.js and jest.setup.js were removed in favour of Vitest, so a Volto 18 project that still runs the Jest harness has to keep its own copy.

The package declares no runtime dependencies in either 5.x or 6.x, so no dependency is added or removed by the upgrade.

Requirements

Backend
Frontend
  • Node.js: >=22.0.0

Installation

  1. Make sure you have a Plone backend up-and-running at http://localhost:8080/Plone

    docker compose up backend
  2. Start Volto frontend

  • If you already have a volto project, just update package.json:

    "dependencies": {
        "@eeacms/volto-corsproxy": "*"
    }

    and volto.config.js:

    const addons = ['@eeacms/volto-corsproxy'];
  • If not, create one with Cookieplone, as recommended by the official Plone documentation for Volto 18+:

    uvx cookieplone project
    cd project-title
  1. Install or update dependencies, then start the project:

    make install

    For a Cookieplone project, start the backend and frontend in separate terminals:

    make backend-start
    make frontend-start
  2. Go to http://localhost:3000

  3. Happy editing!

License

See LICENSE.md for details.

Funding

European Environment Agency (EU)

Keywords