@plone/volto 19.1.6 → 19.3.0

package/src/helpers/Sitemap/Sitemap.js

@@ -6,7 +6,7 @@
 import superagent from 'superagent';
 import map from 'lodash/map';
 import zlib from 'zlib';
-import { toPublicURL } from '@plone/volto/helpers/Url/Url';
+import { getApiSuffix, toPublicURL } from '@plone/volto/helpers/Url/Url';
 import { addHeadersFactory } from '@plone/volto/helpers/Proxy/Proxy';
 
 import config from '@plone/volto/registry';
@@ -22,7 +22,7 @@ export const SITEMAP_BATCH_SIZE = 5000;
 export const generateSitemap = (_req, start = 0, size = undefined) =>
   new Promise((resolve) => {
     const { settings } = config;
-    const apiSuffix = settings.legacyTraverse ? '' : '/++api++';
+    const apiSuffix = getApiSuffix();
     const apiPath = settings.internalApiPath ?? settings.apiPath;
     const request = superagent.get(
       `${apiPath}${apiSuffix}/@search?metadata_fields=modified&b_start=${start}&b_size=${
@@ -64,7 +64,7 @@ export const generateSitemap = (_req, start = 0, size = undefined) =>
 export const generateSitemapIndex = (_req, gzip = false) =>
   new Promise((resolve) => {
     const { settings } = config;
-    const apiSuffix = settings.legacyTraverse ? '' : '/++api++';
+    const apiSuffix = getApiSuffix();
     const apiPath = settings.internalApiPath ?? settings.apiPath;
     const request = superagent.get(
       `${apiPath}${apiSuffix}/@search?metadata_fields=modified&b_size=0&use_site_search_settings=1`,

package/src/helpers/Url/Url.js

@@ -182,6 +182,17 @@ export function addAppURL(url) {
     : `${settings.apiPath}${url}`;
 }
 
+/**
+ * Get the API traversal suffix.
+ *
+ * An explicitly configured apiSuffix takes precedence over legacyTraverse.
+ * @returns {string} API traversal suffix.
+ */
+export function getApiSuffix() {
+  const { settings } = config;
+  return settings.apiSuffix ?? (settings.legacyTraverse ? '' : '/++api++');
+}
+
 /**
  * Given a URL expands it to the backend URL
  * Useful when you have to actually call the backend from the
@@ -193,7 +204,7 @@ export function addAppURL(url) {
  */
 export function expandToBackendURL(path) {
   const { settings } = config;
-  const apiSuffix = settings.legacyTraverse ? '' : '/++api++';
+  const apiSuffix = getApiSuffix();
   let adjustedPath;
   if (path.startsWith('http://') || path.startsWith('https://')) {
     // flattenToAppURL first if we get a full URL

package/src/helpers/Url/Url.test.js

@@ -24,6 +24,7 @@ import {
 } from './Url';
 
 beforeEach(() => {
+  config.settings.apiSuffix = undefined;
   config.settings.legacyTraverse = false;
 });
 
@@ -372,6 +373,20 @@ describe('Url', () => {
       const href = `https://plone.org/api/ca/my-page`;
       expect(expandToBackendURL(href)).toBe('https://plone.org/api/ca/my-page');
     });
+    it('uses apiSuffix in preference to legacyTraverse', () => {
+      settings.apiPath = 'https://plone.org/api';
+      settings.legacyTraverse = true;
+      settings.apiSuffix = '/custom-api';
+      const href = `https://plone.org/api/ca/my-page`;
+      expect(expandToBackendURL(href)).toBe(
+        'https://plone.org/api/custom-api/ca/my-page',
+      );
+    });
+    it('allows apiSuffix to disable the suffix', () => {
+      settings.apiSuffix = '';
+      const href = `/ca/my-page`;
+      expect(expandToBackendURL(href)).toBe('https://plone.org/api/ca/my-page');
+    });
     it('expandToBackendURL test full URL - deployed seamless', () => {
       settings.apiPath = 'https://plone.org';
       const href = `https://plone.org/ca/my-page`;

package/src/server.jsx

@@ -7,7 +7,6 @@ import { Provider } from 'react-intl-redux';
 import express from 'express';
 import { renderToString } from 'react-dom/server';
 import { createMemoryHistory } from 'history';
-import { parse as parseUrl } from 'url';
 import keys from 'lodash/keys';
 import locale from 'locale';
 import { detect } from 'detect-browser';
@@ -247,7 +246,25 @@ server.get('/*', (req, res) => {
   });
 
   const url = req.originalUrl || req.url;
-  const location = parseUrl(url);
+  // Parse the request URL without the deprecated `url.parse()` (DEP0169).
+  // `req.url` is always an origin-form path here, so a plain string split
+  // reproduces the exact `url.parse()` shape (including raw, non-encoded
+  // query strings) that downstream async-connected components rely on.
+  const hashIndex = url.indexOf('#');
+  const withoutHash = hashIndex === -1 ? url : url.slice(0, hashIndex);
+  const hash = hashIndex === -1 ? null : url.slice(hashIndex);
+  const queryIndex = withoutHash.indexOf('?');
+  const pathname =
+    queryIndex === -1 ? withoutHash : withoutHash.slice(0, queryIndex);
+  const search = queryIndex === -1 ? null : withoutHash.slice(queryIndex);
+  const location = {
+    pathname,
+    search,
+    query: search ? search.slice(1) : null,
+    hash,
+    path: withoutHash,
+    href: url,
+  };
 
   loadOnServer({ store, location, routes, api })
     .then(() => {

package/src/start-client.jsx

@@ -77,6 +77,9 @@ export default function client() {
   if (window.env.RAZZLE_INTERNAL_API_PATH) {
     config.settings.internalApiPath = window.env.RAZZLE_INTERNAL_API_PATH;
   }
+  if (typeof window.env.RAZZLE_API_SUFFIX !== 'undefined') {
+    config.settings.apiSuffix = window.env.RAZZLE_API_SUFFIX;
+  }
   // TODO: To be removed when the use of the legacy traverse is deprecated.
   if (window.env.RAZZLE_LEGACY_TRAVERSE) {
     config.settings.legacyTraverse = true;

package/types/actions/querystringsearch/querystringsearch.d.ts

@@ -1,7 +1,55 @@
+/**
+ * Querystring search actions.
+ * @module actions/querystringsearch/querystringsearch
+ */
+import { GET_QUERYSTRING_RESULTS } from '@plone/volto/constants/ActionTypes';
+import { type IntegerLike } from '@plone/volto/helpers/Pagination/Pagination';
+/**
+ * A single `plone.app.querystring` criterion: index, operation, value.
+ */
+export interface QuerystringCriterion {
+    i: string;
+    o: string;
+    v?: unknown;
+}
+/**
+ * The querystring settings stored on a block. Numeric fields are typed as
+ * `IntegerLike` because they are edited through JSON schema `number` widgets
+ * and may reach us as strings.
+ */
+export interface QuerystringData {
+    query?: QuerystringCriterion[];
+    sort_on?: string;
+    sort_order?: string | boolean | null;
+    b_size?: IntegerLike;
+    offset?: IntegerLike;
+    limit?: IntegerLike;
+    depth?: IntegerLike;
+    [key: string]: unknown;
+}
+/**
+ * The payload sent to the `@querystring-search` endpoint. `b_start` is only
+ * present once a page or an offset places the batch past the beginning.
+ */
+export interface QuerystringSearchQuery extends QuerystringData {
+    b_start?: number;
+}
+export interface GetQueryStringResultsAction {
+    type: typeof GET_QUERYSTRING_RESULTS;
+    subrequest?: string;
+    request: {
+        op: 'get' | 'post';
+        path: string;
+        data: QuerystringSearchQuery | null;
+    };
+}
 /**
  * Get querystring results.
  * @function getQueryStringResults
- * @param {Object} data Data.
- * @returns {Object} Get querystringsearch results action.
+ * @param {string} path Path to search under.
+ * @param {QuerystringData} data Querystring settings from the block.
+ * @param {string} subrequest Subrequest id used to store the results.
+ * @param {IntegerLike} page 1-based page number. Defaults to the first page.
+ * @returns {GetQueryStringResultsAction} Get querystringsearch results action.
  */
-export function getQueryStringResults(path: any, data: any, subrequest: any, page: any): any;
+export declare function getQueryStringResults(path: string, data: QuerystringData, subrequest?: string, page?: IntegerLike): GetQueryStringResultsAction;

package/types/components/manage/Widgets/QuerystringWidget.d.ts

@@ -28,6 +28,12 @@ export function objectSchema({ intl, isDisabled, value }: {
             type: string;
             isDisabled: any;
         };
+        offset: {
+            title: any;
+            type: string;
+            isDisabled: any;
+            default: number;
+        };
         b_size: {
             title: any;
             type: string;

package/types/express-middleware/portraits.d.ts

@@ -0,0 +1 @@
+export default function portraitsMiddleware(): any;

package/types/helpers/Api/PloneBackendAPIResourceWithAuth.d.ts

@@ -0,0 +1 @@
+export function getPloneBackendAPIResourceWithAuth(req: any): string;

package/types/helpers/Pagination/Pagination.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Pagination helpers.
+ * @module helpers/Pagination/Pagination
+ */
+/**
+ * A value that is meant to represent an integer, but which reaches us from
+ * user-editable block settings. The querystring widget stores `offset`,
+ * `limit` and `b_size` as JSON schema `number` fields, so a value may arrive
+ * as a string (`'3'`), as a float (`3.7`), or not at all.
+ */
+export type IntegerLike = number | string | null | undefined;
+/**
+ * Compute the `b_start` index for a `@querystring-search` request: the index
+ * of the first item the backend should return for the requested page.
+ *
+ * `offset` shifts the whole result set, letting a listing skip the first N
+ * items of its query while paginating over the remainder.
+ *
+ * Every parameter is coerced to an integer and the result is always a
+ * non-negative integer, so a malformed block setting degrades to a sane batch
+ * rather than sending `NaN` to the backend. When neither `bSize` nor
+ * `defaultPageSize` yields a positive batch size, paging cannot be applied and
+ * the result is `offset` alone.
+ * @function computeBStart
+ * @param {IntegerLike} page 1-based page number. Defaults to the first page.
+ * @param {IntegerLike} offset Number of leading items to skip. Defaults to 0.
+ * @param {IntegerLike} bSize Batch size configured on the block, if any.
+ * @param {IntegerLike} defaultPageSize Batch size to use when bSize is unset.
+ * @returns {number} A non-negative integer `b_start` index.
+ */
+export declare function computeBStart(page: IntegerLike, offset: IntegerLike, bSize: IntegerLike, defaultPageSize: IntegerLike): number;
+/**
+ * Compute the effective `limit` for a `@querystring-search` request.
+ *
+ * A listing that skips the first `offset` items still wants `limit` items
+ * afterwards, so the backend has to return the skipped items on top of the
+ * wanted ones: `offset + limit`.
+ *
+ * A limit of zero, or one that resolves to no usable number, means "no limit"
+ * — matching `plone.app.querystring`'s querybuilder, whose `limit` defaults to
+ * 0 and is only applied when truthy. Returning `offset` in that case would cap
+ * the batch at the very items the listing is about to skip, leaving it empty.
+ * @function computeLimit
+ * @param {IntegerLike} offset Number of leading items to skip. Defaults to 0.
+ * @param {IntegerLike} limit Number of items the listing wants, if capped.
+ * @returns {number | null} A positive integer limit, or null for no limit.
+ */
+export declare function computeLimit(offset: IntegerLike, limit: IntegerLike): number | null;
+/**
+ * Compute how many items a listing can actually show.
+ *
+ * The `items_total` reported by `@querystring-search` is the length of the
+ * whole result set: `plone.restapi`'s HypermediaBatch derives it from the
+ * sequence length, so `b_start` never reduces it. The items an offset skips
+ * are counted in there even though the listing never renders them.
+ * @function computeVisibleTotal
+ * @param {IntegerLike} total The `items_total` reported by the backend.
+ * @param {IntegerLike} offset Number of leading items skipped. Defaults to 0.
+ * @returns {number} A non-negative integer count of reachable items.
+ */
+export declare function computeVisibleTotal(total: IntegerLike, offset: IntegerLike): number;
+/**
+ * Compute how many pages a listing spans.
+ *
+ * `total` is expected to be the reachable item count, so pass the result of
+ * `computeVisibleTotal` for an offset listing rather than the raw backend
+ * total. Otherwise the listing advertises pages that resolve to an empty batch.
+ * @function computeTotalPages
+ * @param {IntegerLike} total Number of items the listing can show.
+ * @param {IntegerLike} bSize Batch size, i.e. items per page.
+ * @returns {number} A non-negative integer page count, 0 when there is no
+ * usable batch size.
+ */
+export declare function computeTotalPages(total: IntegerLike, bSize: IntegerLike): number;

package/types/helpers/Url/Url.d.ts

@@ -54,6 +54,13 @@ export function flattenHTMLToAppURL(html: string): string;
  * @returns {string} New URL with app
  */
 export function addAppURL(url: string): string;
+/**
+ * Get the API traversal suffix.
+ *
+ * An explicitly configured apiSuffix takes precedence over legacyTraverse.
+ * @returns {string} API traversal suffix.
+ */
+export function getApiSuffix(): string;
 /**
  * Given a URL expands it to the backend URL
  * Useful when you have to actually call the backend from the

package/src/actions/querystringsearch/querystringsearch.js

@@ -1,63 +0,0 @@
-import { GET_QUERYSTRING_RESULTS } from '@plone/volto/constants/ActionTypes';
-import config from '@plone/volto/registry';
-
-/**
- * Get querystring results.
- * @function getQueryStringResults
- * @param {Object} data Data.
- * @returns {Object} Get querystringsearch results action.
- */
-export function getQueryStringResults(path, data, subrequest, page) {
-  const { settings } = config;
-
-  // fixes https://github.com/plone/volto/issues/1059
-  let requestData = JSON.parse(JSON.stringify(data));
-
-  if (data?.depth != null) {
-    delete requestData.depth;
-    requestData.query.forEach((q) => {
-      if (q.i === 'path') {
-        // fixes https://github.com/plone/volto/issues/8349
-        // Skip if depth is already embedded in the path value (e.g. set via object browser)
-        const hasEmbeddedDepth = /::\d+$/.test(q.v);
-        if (!hasEmbeddedDepth) q.v += '::' + data.depth;
-      }
-    });
-  }
-
-  // fixes https://github.com/plone/volto/issues/2397
-  if (requestData?.sort_order !== null) {
-    if (typeof requestData.sort_order === 'boolean') {
-      requestData.sort_order = requestData.sort_order
-        ? 'descending'
-        : 'ascending';
-    }
-  }
-
-  const query = {
-    ...requestData,
-    ...(!requestData.b_size && {
-      b_size: settings.defaultPageSize,
-    }),
-    ...(page && {
-      b_start: requestData.b_size
-        ? data.b_size * (page - 1)
-        : settings.defaultPageSize * (page - 1),
-    }),
-    query: requestData?.query,
-  };
-
-  return {
-    type: GET_QUERYSTRING_RESULTS,
-    subrequest,
-    request: {
-      op: settings.querystringSearchGet ? 'get' : 'post',
-      path: `${path}/@querystring-search${
-        settings.querystringSearchGet
-          ? `?query=${encodeURIComponent(JSON.stringify(query))}`
-          : ''
-      }`,
-      data: settings.querystringSearchGet ? null : query,
-    },
-  };
-}