apostrophe 4.23.1-alpha.1 → 4.24.1

package/.github/workflows/main.yml

@@ -18,21 +18,21 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [20, 22]
+        node-version: [20, 22, 24]
         mongodb-version: [6.0, 7.0, 8.0]
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       - name: Git checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
           node-version: ${{ matrix.node-version }}
 
       - name: Start MongoDB
-        uses: supercharge/mongodb-github-action@1.11.0
+        uses: supercharge/mongodb-github-action@1.12.0
         with:
           mongodb-version: ${{ matrix.mongodb-version }}
 

package/CHANGELOG.md

@@ -1,19 +1,40 @@
 # Changelog
 
-## 4.23.1-alpha.1 (2025-11-10)
+## 4.24.1 (2025-12-04)
+
+### Fixes
+
+* Fixes soft-redirect module to decode the URL path before matching historic URLs, ensuring proper matching of accents, Cyrillic, and other non-ASCII characters in old URLs. While this was not a new issue, the fix is of new importance now that a migration path to eliminate accent marks in existing slugs has been introduced in version 4.24.0.
+
+## 4.24.0 (2025-11-25)
 
 ### Adds
 
+* Adds `stripUrlAccents` option in `@apostrophecms/i18n` module to globally control whether accents are stripped from URLs. When set to `true`, all URLs (slugs) will have accents from Latin characters removed on document creation and updates. No existing documents are modified automatically; this only affects new or updated documents. A new task `node app @apostrophecms/i18n:strip-slug-accents` is provided to update existing document slugs in the database when needed.
+* Add `@apostrophecms/migration:add-missing-schema-fields` task. This task does not run database migrations.
 * Translation strings added for the layout- and layout-column-widgets.
+* Adds `@apostrophecms/doc:get-apos-doc-id` and `@apostrophecms/doc:set-apos-doc-id` tasks.
+* New `box` schema field type
+* When switching locale from the doc editor, ask if the user wants to localize the current document in the target locale or want to start a blank document.
+* Adds batch failure notifications.
+* Introduced a new `longPolling: false` option for the `@apostrophecms/notification` module. This eliminates long-pending requests when logged in, but also slows down the delivery of notifications. The behavior can be tuned further via the `pollingInterval` option, which defaults to `5000` milliseconds.
+* Add support for `def` in area fields - array of widget names to use as defaults when the area is created.
 
 ### Changes
 
+* `@apostrophecms/migration:requirements` handler now runs the migration requirements like `insertIfMissing`, `implementParkAllInDefaultLocale`, `replicate` and `implementParkAllInOtherLocales`.
 * Bump nodemailer to v7.x.
+* Improves client error log when unable to render a widget.
+* Rich text `styles` are once again available to insert menu items, such as our optional `@apostrophecms/ai-helper` module.
 
 ### Fixes
 
 * Specify the content type when calling back to Astro with JSON to render an area. This is required starting in Astro 4.9.0 and up, otherwise the request is blocked by CSRF protection.
-* Improved support for Node.js on "plain vanilla" Windows, without WSL.
+* Improved support for Node.js on "plain vanilla" Windows, e.g. without WSL. We suggest working with NVM for Windows and Git Bash.
+* Fixes `AposBreadcrumbSwitch` tooltip prop that is supposed to be an object, not a string. Object returned from the shared method `getOperationTooltip`.
+* Empty text nodes are output properly without a warning.
+* Uses `modalData.locale` in `AposI18nLocalize` component. Fixes watcher on `relatedDocTypes` not being properly triggered (uses data and methods for more control instead).
+* Layout area fix when no columns are present.
 
 ## 4.23.0 (2025-10-30)
 

package/defaults.js

@@ -46,8 +46,10 @@ module.exports = {
     '@apostrophecms/rich-text-widget': {},
     '@apostrophecms/html-widget': {},
     '@apostrophecms/color-field': {},
+    '@apostrophecms/box-field': {},
     '@apostrophecms/oembed-field': {},
     '@apostrophecms/video-widget': {},
+    '@apostrophecms/file-widget': {},
     '@apostrophecms/ui': {},
     '@apostrophecms/user': {},
     '@apostrophecms/settings': {},

package/index.js

@@ -13,6 +13,7 @@ const npmResolve = require('resolve');
 const glob = require('./lib/glob.js');
 const moogRequire = require('./lib/moog-require');
 const importFresh = require('./lib/import-fresh');
+const { pathToFileURL } = require('node:url');
 let defaults = require('./defaults.js');
 
 // ## Top-level options
@@ -322,21 +323,7 @@ async function apostrophe(options, telemetry, rootSpan) {
     await self.emit('modulesRegistered'); // formerly modulesReady
     self.apos.schema.validateAllSchemas();
     self.apos.schema.registerAllSchemas();
-    await self.apos.lock.withLock('@apostrophecms/migration:migrate', async () => {
-      await self.apos.migration.migrate(self.argv);
-      // Inserts the global doc in the default locale if it does not exist;
-      // same for other singleton piece types registered by other modules
-      for (const apostropheModule of Object.values(self.modules)) {
-        if (self.instanceOf(apostropheModule, '@apostrophecms/piece-type') && apostropheModule.options.singletonAuto) {
-          await apostropheModule.insertIfMissing();
-        }
-      }
-      await self.apos.page.implementParkAllInDefaultLocale();
-      await self.apos.doc.replicate(); // emits beforeReplicate and afterReplicate events
-      // Replicate will have created the parked pages across locales if needed,
-      // but we may still need to reset parked properties
-      await self.apos.page.implementParkAllInOtherLocales();
-    });
+    await self.apos.migration.migrate(self.argv);
     await self.emit('ready'); // formerly afterInit
 
     if (self.taskRan) {
@@ -376,7 +363,7 @@ async function apostrophe(options, telemetry, rootSpan) {
     const reallyLocalPath = self.rootDir + localPath;
 
     if (fs.existsSync(reallyLocalPath)) {
-      local = await self.root.import(reallyLocalPath);
+      local = await self.root.import(pathToFileURL(reallyLocalPath));
     }
 
     // Otherwise making a second apos instance
@@ -408,7 +395,7 @@ async function apostrophe(options, telemetry, rootSpan) {
     const configs = glob(self.localModules + '/**/modules.js', { follow: true });
     for (const config of configs) {
       try {
-        _.merge(self.options.modules, await self.root.import(config));
+        _.merge(self.options.modules, await self.root.import(pathToFileURL(config)));
       } catch (e) {
         console.error(stripIndent`
           When nestedModuleSubdirs is active, any modules.js file beneath:
@@ -526,7 +513,7 @@ async function apostrophe(options, telemetry, rootSpan) {
     checkTestModule();
     // Allow tests to be in test/ or in tests/
     const testDir = path.dirname(m.filename);
-    const moduleDir = testDir.replace(/\/tests?$/, '');
+    const moduleDir = testDir.replace(/\/tests?$/, '').replace(/\\tests?$/, '');
     if (testDir === moduleDir) {
       throw new Error('Test file must be in test/ or tests/ subdirectory of module');
     }
@@ -540,7 +527,7 @@ async function apostrophe(options, telemetry, rootSpan) {
 
     if (!fs.existsSync(testDir + '/node_modules')) {
       fs.mkdirSync(testDir + '/node_modules' + pkgNamespace, { recursive: true });
-      fs.symlinkSync(moduleDir, testDir + '/node_modules/' + pkgName, 'dir');
+      fs.symlinkSync(moduleDir, testDir + '/node_modules/' + pkgName, 'junction');
     }
     // Makes sure we encounter mocha along the way
     // and throws an exception if we don't
@@ -734,7 +721,7 @@ async function apostrophe(options, telemetry, rootSpan) {
           if (fs.existsSync(path.resolve(self.localModules, name, 'modules.js'))) {
             return;
           }
-          const submodule = await self.root.import(path.resolve(self.localModules, name, 'index.js'));
+          const submodule = await self.root.import(pathToFileURL(path.resolve(self.localModules, name, 'index.js')));
           if (
             submodule &&
             submodule.options &&
@@ -914,8 +901,19 @@ function getRoot(options) {
   if (root?.filename && root?.require) {
     return {
       filename: root.filename,
-      import: async (id) => root.require(id),
-      require: (id) => root.require(id)
+      async import(id) {
+        // Must accept URL objects
+        id = id.toString();
+        // To accurately simulate ES import, we need to
+        // accept file:// URLs like it can
+        if (id.startsWith('file:')) {
+          id = url.fileURLToPath(id);
+        }
+        return root.require(id);
+      },
+      require(id) {
+        return root.require(id);
+      }
     };
   }
 
@@ -957,8 +955,19 @@ function getRoot(options) {
   const legacyRoot = getLegacyRoot();
   return {
     filename: legacyRoot.filename,
-    import: async (id) => legacyRoot.require(id),
-    require: (id) => legacyRoot.require(id)
+    async import(id) {
+      // Must accept URL objects
+      id = id.toString();
+      // To accuratesly simulate ES import, we need to
+      // accept file:// URLs like it can
+      if (id.startsWith('file:')) {
+        id = url.fileURLToPath(id);
+      }
+      return legacyRoot.require(id);
+    },
+    require(id) {
+      return legacyRoot.require(id);
+    }
   };
 };
 

package/lib/glob.js

@@ -1,10 +1,12 @@
 const { globSync } = require('glob');
 
 // synchronous glob 10 but with the sorting semantics of glob 8,
-// to ease backwards compatibility in Apostrophe startup logic
+// to ease backwards compatibility in Apostrophe startup logic.
+// Also replaces \ with / for consistency across platforms
 
 module.exports = (pattern, options) => {
-  const result = globSync(pattern, options);
+  pattern = pattern.replaceAll('\\', '//');
+  const result = globSync(pattern, options).map(path => path.replaceAll('\\', '/'));
   if (!options.nosort) {
     result.sort((a, b) => a.localeCompare(b, 'en'));
   }

package/lib/moog.js

@@ -189,7 +189,7 @@ module.exports = function(options) {
         }
         // You can have access to options within a function, if you choose to
         // provide one
-        const properties = ((typeof step[cascade]) === 'function') ? step[cascade](that, options) : step[cascade];
+        const properties = ((typeof step[cascade]) === 'function') ? await step[cascade](that, options) : step[cascade];
         if (properties) {
           const valid = [ 'add', 'remove', 'order', 'group' ];
           if (properties.add) {

package/modules/@apostrophecms/area/ui/apos/components/AposBreadcrumbSwitch.vue

@@ -51,7 +51,7 @@ export default {
       required: true
     },
     tooltip: {
-      type: String,
+      type: Object,
       default: null
     },
     disabled: {

package/modules/@apostrophecms/area/ui/apos/logic/AposAreaEditor.js

@@ -626,10 +626,24 @@ export default {
     },
     // Return a new widget object in which defaults are fully populated,
     // especially valid sub-area objects, so that nested edits work on the page
-    newWidget(type) {
+    // Optional schemaOverride array can be provided to override any fields from
+    // the base schema. Useful for e.g. per-instance defaults.
+    newWidget(type, schemaOverride) {
       const schema = apos.modules[apos.area.widgetManagers[type]].schema;
+      const finalSchema = Array.isArray(schemaOverride)
+        ? schema.map(field => {
+          const _field = schemaOverride.find(f => f.name === field.name);
+          if (_field) {
+            return {
+              ...field,
+              ..._field
+            };
+          }
+          return field;
+        })
+        : schema;
       const widget = {
-        ...newInstance(schema),
+        ...newInstance(finalSchema),
         type
       };
       return widget;

package/modules/@apostrophecms/asset/index.js

@@ -6,7 +6,7 @@ const { stripIndent } = require('common-tags');
 const { createId } = require('@paralleldrive/cuid2');
 const chokidar = require('chokidar');
 const _ = require('lodash');
-const { glob } = require('glob');
+const { glob } = require('./lib/path');
 const globalIcons = require('./lib/globalIcons');
 const {
   checkModulesWebpackConfig,
@@ -31,7 +31,7 @@ module.exports = {
     // If false no UI assets sources will be watched in development.
     // This option has no effect in production (watch disabled).
     watch: true,
-    // Miliseconds to wait between asset sources changes before
+    // Milliseconds to wait between asset sources changes before
     // performing a build.
     watchDebounceMs: 1000,
     // Object containing instructions for remapping existing bundles.
@@ -939,7 +939,8 @@ module.exports = {
         const pulledChanges = [];
         let change = changes.pop();
         while (change) {
-          pulledChanges.push(change);
+          // Fix windows paths
+          pulledChanges.push(change.replace(/\\/g, '/'));
           change = changes.pop();
         }
         // No changes - should never happen.

package/modules/@apostrophecms/asset/lib/build/external-module-api.js

@@ -1,6 +1,6 @@
 const fs = require('fs-extra');
 const path = require('node:path');
-const { glob } = require('glob');
+const { glob } = require('../../lib/path');
 const { stripIndent } = require('common-tags');
 
 // High and Low level public API for external modules.
@@ -196,7 +196,7 @@ function invoke() {
 }` + '\n'
         : '';
 
-      // Remove the identation per line.
+      // Remove the indentation per line.
       // It may look weird, but the result is nice and formatted import file.
       output += (js && js.invokeCode.trim().split('\n').map(l => l.trim()).join('\n') + '\n') || '';
 
@@ -653,7 +653,9 @@ function invoke() {
             }
           }
         }
-        const jsFilename = JSON.stringify(component);
+        // You would think we should run pathToFileURL over realPath,
+        // but that actually breaks both Windows and Linux with Vite. -Tom
+        const importPath = JSON.stringify(realPath);
         const name = self.getComponentNameByPath(
           component,
           { enumerate: options.enumerateImports === true ? i : false }
@@ -661,8 +663,8 @@ function invoke() {
         const jsName = JSON.stringify(name);
         const importName = `${name}${options.importSuffix || ''}`;
         const importCode = options.importName === false
-          ? `import ${jsFilename};\n`
-          : `import ${importName} from ${jsFilename};\n`;
+          ? `import ${importPath};\n`
+          : `import ${importName} from ${importPath};\n`;
 
         output.importCode += `${importCode}`;
 
@@ -720,6 +722,7 @@ function invoke() {
         let importName = importFrom;
         if (!importIndex.includes(importFrom)) {
           if (importFrom.substring(0, 1) === '~') {
+            // An npm module name
             importName = self.apos.util.slugify(importFrom).replaceAll('-', '');
             output.importCode += `import ${importName}Icon from '${importFrom.substring(1)}';\n`;
           } else {

package/modules/@apostrophecms/asset/lib/build/internals.js

@@ -1,7 +1,7 @@
 const fs = require('fs-extra');
 const path = require('node:path');
 const util = require('node:util');
-const { glob } = require('glob');
+const { glob } = require('../../lib/path');
 const { getBuildExtensions, fillExtraBundles } = require('./utils');
 
 // Internal build interface.
@@ -127,11 +127,12 @@ module.exports = (self) => {
     // Get the component name from a file path. The `enumerate` option allows
     // to append a number to the component name.
     getComponentNameByPath(componentPath, { enumerate } = {}) {
-      return path
+      const result = path
         .basename(componentPath)
         .replace(/-/g, '_')
         .replace(/\s+/g, '')
         .replace(/\.\w+/, '') + (typeof enumerate === 'number' ? `_${enumerate}` : '');
+      return result;
     },
 
     // Return the reported by the external module during build dev server URL.
@@ -201,7 +202,7 @@ module.exports = (self) => {
     // return a list of all bundle files.
     //
     // The `bundles` (Set) property added to the entrypoints configuration
-    // contans the bundle files used later when injecting the scripts and
+    // contains the bundle files used later when injecting the scripts and
     // stylesheets in the browser. The `metadata` is the return value of the
     // external build module build method (see `self.build()` and
     // `configureBuildModule()`).

package/modules/@apostrophecms/asset/lib/build/task.js

@@ -5,6 +5,7 @@ const fs = require('fs-extra');
 const { stripIndent } = require('common-tags');
 const webpackModule = require('webpack');
 const { mergeWithCustomize: webpackMerge } = require('webpack-merge');
+const { pathToFileURL } = require('node:url');
 const {
   getBundlesNames,
   writeBundlesImportFiles,
@@ -675,12 +676,13 @@ module.exports = (self) => ({
                   `);
           }
         }
-        const jsFilename = JSON.stringify(component);
+        // We know component is a file path at this point
+        const importUrl = JSON.stringify(pathToFileURL(component));
         const name = getComponentName(component, options, i);
         const jsName = JSON.stringify(name);
         const importName = `${name}${options.importSuffix || ''}`;
         const importCode = `
-              import ${importName} from ${jsFilename};
+              import ${importName} from ${importUrl};
               `;
 
         output.paths.push(component);

package/modules/@apostrophecms/asset/lib/path.js

@@ -0,0 +1,24 @@
+const { glob: globOriginal } = require('glob');
+const {
+  resolve: resolveOriginal,
+  dirname: dirnameOriginal
+} = require('path');
+
+module.exports = {
+  glob,
+  resolve,
+  dirname
+};
+
+async function glob(path, options) {
+  const results = await globOriginal(path, options);
+  return results.map(result => result.replaceAll('\\', '/'));
+}
+
+function resolve(...args) {
+  return resolveOriginal(...args).replaceAll('\\', '/');
+}
+
+function dirname(path) {
+  return dirnameOriginal(path).replaceAll('\\', '/');
+}

package/modules/@apostrophecms/asset/lib/webpack/utils.js

@@ -284,7 +284,7 @@ async function verifyBundlesEntryPoints (bundles) {
       // already verified it's unique for the given module
       if (!remapping.source) {
         // Bundle name for "main" "doesn't matter - it will be ignored and
-        // never built, we want to achieve a free from colision name. What
+        // never built, we want to achieve a free from collision name. What
         // matters is main = true. Target is 'main' by convention:
         // `main.bundleName`
         bundleName = `${remapping.target}.${bundleName}`;

package/modules/@apostrophecms/box-field/index.js

@@ -0,0 +1,157 @@
+module.exports = {
+  options: {
+    name: 'box',
+    alias: 'boxField'
+  },
+  init(self) {
+    self.name = self.options.name;
+    self.addFieldType();
+    self.enableBrowserData();
+  },
+  methods(self) {
+    return {
+      addFieldType() {
+        self.apos.schema.addFieldType({
+          name: 'box',
+          convert(req, field, data, destination) {
+            const defProps = [ 'top', 'right', 'bottom', 'left' ];
+            const temp = {};
+            const min = self.apos.launder.integer(field.min);
+            let max = null;
+
+            if ('max' in field) {
+              max = self.apos.launder.integer(field.max);
+            }
+
+            // All values to numbers or null
+            defProps.forEach(side => {
+              const int = parseInt(data[field.name][side]);
+              if (int || int === 0) {
+                temp[side] = int;
+              } else {
+                temp[side] = null;
+              }
+            });
+
+            // One non-null value if required
+            if (field.required) {
+              const unique = [ ...new Set(Object.values(temp)) ];
+              if (unique.length === 1 && unique[0] === null) {
+                throw self.apos.error('required');
+              }
+            }
+
+            // Minimum values in range
+            for (const key of defProps) {
+              if (temp[key] && temp < min) {
+                throw self.apos.error(`${key} is below the min ${field.min}, is ${temp[key]}`);
+              }
+            }
+
+            // Maximum values in range
+            if (max) {
+              for (const key of defProps) {
+                if (temp[key] && temp[key] > field.max) {
+                  throw self.apos.error(`${key} is greater than the max ${field.max}, is ${temp[key]}`);
+                }
+              }
+            }
+
+            // Copy values to destination
+            destination[field.name] = temp;
+          },
+          validate(field, options, warn, fail) {
+            const defProps = [ 'top', 'right', 'bottom', 'left' ];
+            let defMin = 0;
+
+            if (field.max && typeof field.max !== 'number') {
+              fail('Property "max" must be a number');
+            }
+
+            if (field.step && typeof field.step !== 'number') {
+              fail('Property "step" must be a number');
+            }
+
+            if (field.def) {
+              const fieldDefProps = Object.keys(field.def);
+              if (
+                !(fieldDefProps.length === defProps.length &&
+                fieldDefProps.every(k => defProps.includes(k)))
+              ) {
+                fail('Def must be an object with only "top", "right", "bottom", and "left" keys');
+              }
+
+              for (const key in field.def) {
+                if (!Number.isFinite(field.def[key])) {
+                  fail(`Default property "${key}" must be a number`);
+                }
+              }
+            }
+
+            if (field.min) {
+              if (typeof field.min !== 'number') {
+                fail('Property "min" must be a number');
+              }
+            } else {
+              if (field.def) {
+                // if def has a negative value, it needs to be the min
+                const fieldDefMin = Math.min(...Object.values(field.def));
+                if (defMin > fieldDefMin) {
+                  defMin = fieldDefMin;
+                }
+              }
+              field.min = defMin;
+            }
+
+          },
+          def: {
+            top: null,
+            right: null,
+            bottom: null,
+            left: null
+          }
+        });
+      },
+      getBrowserData(req) {
+        return {
+          name: self.name,
+          action: self.action
+        };
+      }
+    };
+  },
+  helpers() {
+    return {
+      toCss(value, property, unit = 'px') {
+        const {
+          top, right, bottom, left
+        } = value;
+        const vals = [ top, right, bottom, left ];
+
+        if (vals.every(v => v == null)) {
+          return '';
+        };
+
+        if (vals.every(v => v === top && v != null)) {
+          return `${property}: ${top}${unit};`;
+        }
+
+        const sides = {
+          top,
+          right,
+          bottom,
+          left
+        };
+        const parts = [];
+
+        for (const [ side, val ] of Object.entries(sides)) {
+          if (val != null) {
+            parts.push(`${property}-${side}: ${val}${unit};`);
+          }
+        }
+
+        return parts.join(' ');
+      }
+    };
+  }
+};