apostrophe 3.10.0 → 3.13.0

package/CHANGELOG.md

@@ -1,5 +1,58 @@
 # Changelog
 
+## 3.13.0 - 2022-02-04
+
+### Adds
+
+* Additional requirements and related UI may be imposed on native ApostropheCMS logins using the new `requirements` feature, which can be extended in modules that `improve` the `@apostrophecms/login` module. These requirements are not imposed for single sign-on logins via `@apostrophecms/passport-bridge`. See the documentation for more information.
+* Adds latest Slovak translation strings to SK.json in `i18n/` folder. Thanks to [Michael Huna](https://github.com/Miselrkba) for the contribution.
+* Verifies `afterPasswordVerified` requirements one by one when emitting done event, allows to manage errors ans success before to go to the next requirement. Stores and validate each requirement in the token. Checks the new `askForConfirmation` requirement option to go to the next step when emitting done event or waiting for the confirm event (in order to manage success messages). Removes support for `afterSubmit` for now.
+
+### Fixes
+
+* Decodes the testReq `param` property in `serveNotFound`. This fixes a problem where page titles using diacritics triggered false 404 errors.
+* Registers the default namespace in the Vue instance of i18n, fixing a lack of support for un-namespaced l10n keys in the UI.
+
+## 3.12.0 - 2022-01-21
+
+### Adds
+
+* It is now best practice to deliver namespaced i18n strings as JSON files in module-level subdirectories of `i18n/` named to match the namespace, e.g. `i18n/ourTeam` if the namespace is `ourTeam`. This allows base class modules to deliver phrases to any namespace without conflicting with those introduced at project level. The `i18n` option is now deprecated in favor of the new `i18n` module format section, which is only needed if `browser: true` must be specified for a namespace.
+* Brought back the `nestedModuleSubdirs` feature from A2, which allows modules to be nested in subdirectories if `nestedModuleSubdirs: true` is set in `app.js`. As in A2, module configuration (including activation) can also be grouped in a `modules.js` file in such subdirectories.
+
+### Fixes
+
+* Fixes minor inline documentation comments.
+* UI strings that are not registered localization keys will now display properly when they contain a colon (`:`). These were previously interpreted as i18next namespace/key pairs and the "namespace" portion was left out.
+* Fixes a bug where changing the page type immediately after clicking "New Page" would produce a console error. In general, areas and checkboxes now correctly handle their value being changed to `null` by the parent schema after initial startup of the `AposInputArea` or `AposInputCheckboxes` component.
+* It is now best practice to deliver namespaced i18n strings as JSON files in module-level subdirectories of `i18n/` named to match the namespace, e.g. `i18n/ourTeam` if the namespace is `ourTeam`. This allows base class modules to deliver phrases to any namespace without conflicting with those introduced at project level. The `i18n` option is now deprecated in favor of the new `i18n` module format section, which is only needed if `browser: true` must be specified for a namespace.
+* Removes the `@apostrophecms/util` module template helper `indexBy`, which was using a lodash method not included in lodash v4.
+* Removes an unimplemented `csrfExceptions` module section cascade. Use the `csrfExceptions` *option* of any module to set an array of URLs excluded from CSRF protection. More information is forthcoming in the documentation.
+* Fix `[Object Object]` in the console when warning `A permission.can() call was made with a type that has no manager` is printed.
+
+### Changes
+
+* Temporarily removes `npm audit` from our automated tests because of a sub-dependency of vue-loader that doesn't actually cause a security vulnerability for apostrophe.
+
+## 3.11.0 - 2022-01-06
+
+### Adds
+
+* Apostrophe now extends Passport's `req.login` to emit an `afterSessionLogin` event from the `@apostrophecms:login` module, with `req` as an argument. Note that this does not occur at all for login API calls that return a bearer token rather than establishing an Express session.
+
+### Fixes
+
+* Apostrophe's extension of `req.login` now accounts for the `req.logIn` alias and the skippable `options` parameter, which is relied upon in some `passport` strategies.
+* Apostrophe now warns if a nonexistent widget type is configured for an area field, with special attention to when `-widget` has been erroneously included in the name. For backwards compatibility this is a startup warning rather than a fatal error, as sites generally did operate successfully otherwise with this type of bug present.
+
+### Changes
+
+* Unpins `vue-click-outside-element` the packaging of which has been fixed upstream.
+* Adds deprecation note to `__testDefaults` option. It is not in use, but removing would be a minor BC break we don't need to make.
+* Allows test modules to use a custom port as an option on the `@apostrophecms/express` module.
+* Removes the code base pull request template to instead inherit the organization-level template.
+* Adds `npm audit` back to the test scripts.
+
 ## 3.10.0 - 2021-12-22
 
 ### Fixes

package/index.js

@@ -7,6 +7,7 @@ const cluster = require('cluster');
 const { cpus } = require('os');
 const process = require('process');
 const npmResolve = require('resolve');
+const glob = require('glob');
 
 let defaults = require('./defaults.js');
 
@@ -273,6 +274,33 @@ module.exports = async function(options) {
     return _module;
   }
 
+  function nestedModuleSubdirs() {
+    if (!options.nestedModuleSubdirs) {
+      return;
+    }
+    const configs = glob.sync(self.localModules + '/**/modules.js');
+    _.each(configs, function(config) {
+      try {
+        _.merge(self.options.modules, require(config));
+      } catch (e) {
+        console.error(stripIndent`
+          When nestedModuleSubdirs is active, any modules.js file beneath:
+
+          ${self.localModules}
+
+          must export an object containing configuration for Apostrophe modules.
+          
+          The file:
+          
+          ${config}
+          
+          did not parse.
+        `);
+        throw e;
+      }
+    });
+  }
+
   function autodetectBundles() {
     const modules = _.keys(self.options.modules);
     _.each(modules, function(name) {
@@ -406,7 +434,13 @@ module.exports = async function(options) {
       localModules: self.localModules,
       defaultBaseClass: '@apostrophecms/module',
       sections: [ 'helpers', 'handlers', 'routes', 'apiRoutes', 'restApiRoutes', 'renderRoutes', 'middleware', 'customTags', 'components', 'tasks' ],
-      unparsedSections: [ 'queries', 'extendQueries', 'icons' ]
+      nestedModuleSubdirs: self.options.nestedModuleSubdirs,
+      unparsedSections: [
+        'queries',
+        'extendQueries',
+        'icons',
+        'i18n'
+      ]
     });
 
     self.synth = synth;
@@ -417,6 +451,8 @@ module.exports = async function(options) {
     self.redefine = self.synth.redefine;
     self.create = self.synth.create;
 
+    nestedModuleSubdirs();
+
     _.each(self.options.modules, function(options, name) {
       synth.define(name, options);
     });

package/lib/moog.js

@@ -369,9 +369,9 @@ module.exports = function(options) {
     }
 
     function capture(section) {
-      that[section] = {};
+      that.__meta[section] = {};
       for (const step of steps) {
-        that[section][step.__meta.name] = step[section];
+        that.__meta[section][step.__meta.name] = step[section];
       }
     }
 

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

@@ -12,6 +12,8 @@ module.exports = {
   'checkbox-blank-icon': 'CheckboxBlankOutline',
   'check-all-icon': 'CheckAll',
   'check-bold-icon': 'CheckBold',
+  'check-circle-icon': 'CheckCircle',
+  'check-decagram-icon': 'CheckDecagram',
   'checkbox-marked-icon': 'CheckboxMarked',
   'chevron-down-icon': 'ChevronDown',
   'chevron-left-icon': 'ChevronLeft',

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

@@ -1114,7 +1114,7 @@ module.exports = {
               await copyOut(uploadfsPath, tempFile);
               await self.sanitizeSvg(tempFile);
               await copyIn(tempFile, uploadfsPath);
-              await self.db.update({
+              await self.db.updateOne({
                 _id: attachment._id
               }, {
                 $set: {

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

@@ -675,10 +675,10 @@ module.exports = {
       },
 
       // Insert the given document. Called by `.insert()`. You will usually want to
-      // call the update method of the appropriate doc type manager instead:
+      // call the insert method of the appropriate doc type manager instead:
       //
       // ```javascript
-      // self.apos.doc.getManager(doc.type).update(...)
+      // self.apos.doc.getManager(doc.type).insert(...)
       // ```
       //
       // However you can override this method to alter the

package/modules/@apostrophecms/doc-type/index.js

@@ -194,11 +194,11 @@ module.exports = {
             _id: doc._id.replace(':draft', ':previous')
           });
           if (published) {
-            await self.apos.doc.db.remove({ _id: published._id });
+            await self.apos.doc.db.removeOne({ _id: published._id });
             await self.emit('afterDelete', req, published, { checkForChildren: false });
           }
           if (previous) {
-            await self.apos.doc.db.remove({ _id: previous._id });
+            await self.apos.doc.db.removeOne({ _id: previous._id });
             await self.emit('afterDelete', req, previous, { checkForChildren: false });
           }
         },

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

@@ -307,7 +307,13 @@ module.exports = {
           // "expires" ourselves too
           const bearer = await self.apos.login.bearerTokens.findOne({
             _id: req.token,
-            expires: { $gte: new Date() }
+            expires: { $gte: new Date() },
+            // requirementsToVerify array should be empty or inexistant
+            // for the token to be usable to log in.
+            $or: [
+              { requirementsToVerify: { $exists: false } },
+              { requirementsToVerify: { $ne: [] } }
+            ]
           });
           return bearer && bearer.userId;
         }

package/modules/@apostrophecms/i18n/i18n/en.json

@@ -167,6 +167,7 @@
   "localizeNewRelated": "Localize new related documents",
   "localizingBusy": "Localizing Content",
   "login": "Login",
+  "loginErrorGeneric": "An error occurred. Please try again.",
   "loginDisabled": "Login Disabled",
   "loginPageBothRequired": "Both the username and the password are required.",
   "loginPageBadCredentials": "Your credentials are incorrect, or there is no such user",

package/modules/@apostrophecms/i18n/i18n/sk.json

@@ -3,6 +3,7 @@
   "addItem": "Pridať položku",
   "addWidgetType": "Pridať {{ label }}",
   "admin": "Admin",
+  "affirmativeLabel": "Áno, pokračovať.",
   "altText": "Alternatívny text",
   "altTextHelp": "Alternatívny popis obrázkov pre zlepšenú prístupnosť",
   "any": "ľubovoľný",
@@ -10,6 +11,8 @@
   "applyToSubpages": "Aplikovať na podstánky",
   "arrayCancelDescription": "Chcete zahodiť zmeny v tomto zozname?",
   "archive": "Archív",
+  "archivingBatchConfirmation": "Naozaj chcete archivovať {{ count }} {{ type }}?",
+  "archivingBatchConfirmationButton": "Áno, archivovať obsah.",
   "archiveImage": "Archivovať obrázok",
   "archiveOnlyThisPage": "Archivovať len túto stránku",
   "archivePageAndSubpages": "Archivovať túto stránku a všetky podradené stránky",
@@ -121,6 +124,7 @@
   "errorPageMessage": "Došlo k chybe",
   "errorPageStatusCode": "500",
   "errorPageTitle": "Došlo k chybe v nadpise stánky",
+  "errorBatchOperationNoti": "Skupinová operácia {{ operation }} zlyhala.",
   "everythingElse": "Všetko ostatné",
   "exit": "Odísť",
   "fetchPublishedVersionFailed": "Pri načítaní zverejnenej verzie dokumentu sa vyskytla chyba.",
@@ -173,6 +177,8 @@
   "manageDocType": "Spravovať {{ type }}",
   "manageDraftSubmissions": "Spravujte návrhy príspevkov",
   "managePages": "Spravovať stránky",
+  "maxLabel": "Max:",
+  "maxUi": "Max: {{ number }}",
   "mediaCreatedDate": "Nahraté: {{ createdDate }}",
   "mediaDimensions": "Rozmery: {{ width }} 𝗑 {{ height }}",
   "mediaFileSize": "Veľkosť súboru: {{ fileSize }}",
@@ -180,6 +186,10 @@
   "mediaMB": "{{ size }}MB",
   "mediaUploadViaDrop": "Presuňte ich sem, keď budete pripravení",
   "mediaUploadViaExplorer": "Alebo kliknutím otvorte adresárovú štruktúru",
+  "minLabel": "Min:",
+  "minUi": "Min: {{ number }}",
+  "modify": "Zmeniť",
+  "modifyOrDelete": "Zmeniť / Vymazať",
   "moreOptions": "Viac možností",
   "moreOperations": "Viac úprav",
   "multipleEditors": "Viaceré editory",
@@ -202,17 +212,19 @@
   "notFoundPageStatusCode": "404",
   "notFoundPageTitle": "404 - Stránka nenájdená",
   "notInLocale": "Aktuálna stránka v {{ label }} neexistuje. Preložte verziu z {{ currentLocale }}?",
+  "notificationClearEventError": "Pri vymazávaní zaregistrovanej notifikačnej udalosti sa vyskytla chyba.",
   "noTypeFound": "Nenašiel sa žiadny {{ type }}",
   "parentNotLocalized": "Najprv preložte nadradenú stránku",
   "notYetPublished": "Tento dokument ešte nebol zverejnený.",
   "nudgeDown": "Posunúť nadol",
   "nudgeUp": "Posunúť nahor",
+  "numberAdded": "{{ count }} Pridané",
   "office": "Kancelária",
   "openGlobal": "Otvorte globálne nastavenia webu",
   "page": "Stránka",
   "pageDoesNotExistYet": "Stránka zatiaľ neexistuje",
   "pageDoesNotExistYetDescription": "Stránka, ktorá poskytuje záznam pre tento diel, ešte nie je k dispozícii ako {{ mode }} v jazykovej mutácii {{ locale }}.",
-  "pageIsParked": "Táto stránka je zaparkovaná a nemožno ju presunúť",
+  "pageIsParked": "Táto stránka je uzamknutá nemožno ju presunúť",
   "pageNumber": "Stránka {{ number }}",
   "pageTitle": "Názov stránky",
   "pages": "Stránky",
@@ -242,6 +254,8 @@
   "richTextUndo": "Vrátiť späť",
   "richTextStyleConfigWarning": "Nesprávne nakonfigurovaný štýl: popiska: {{ label }}, {{ tag }}",
   "password": "Heslo",
+  "passwordErrorMin": "Minimum {{ min }} znakov",
+  "passwordErrorMax": "Maximum {{ max }} znakov",
   "passwordResetRequest": "Vaša žiadosť o obnovenie hesla zo stránky {{ site }}",
   "pasteWidget": "Prilepiť {{ widget }}",
   "pending": "Čaká na spracovanie",
@@ -277,6 +291,8 @@
   "relatedDocsOnly": "Len súvisiace dokumenty",
   "relatedDocsDefinition": "Súvisiace dokumenty sú dokumenty, na ktoré sa odkazuje v tomto dokumente. Obvykle to zahŕňa obrázky, obsah definovaný vzťahmi atď.",
   "restore": "Obnoviť",
+  "restoreBatchConfirmation": "Naozaj chcete obnoviť {{ count }} {{ type }}?",
+  "restoreBatchConfirmationButton": "Áno, obnoviť obsah.",
   "resolveErrorsBeforeSaving": "Pred uložením vyriešte chyby.",
   "resolveErrorsFirst": "Najprv vyriešte chyby.",
   "restoreOnlyThisPage": "Obnovte iba túto stránku",
@@ -305,6 +321,12 @@
   "select": "Vybrať",
   "selectedMenuItem": "✓ {{ label }}",
   "selectAll": "Vybrať všetko",
+  "selectBoxMessage": "{{ num }} {{ label }} vybraté.",
+  "selectBoxMessagePage": "{{ num }} {{ label }} na tejto stránke vybraté.",
+  "selectBoxMessageAllButton": "Vybrať všetko {{ num }} {{ label }}.",
+  "selectBoxMessageButton": "Vybrať {{ num }} {{ label }}.",
+  "selectBoxMessageSelected": "{{ num }} {{ label }} vybraté.",
+  "selectBoxMessageAllSelected": "Všetky {{ num }} {{ label }} vybraté.",
   "deselectAll": "Odznačiť všetko",
   "selectContent": "Vyberte obsah",
   "selectContentToLocalize": "Ktorý obsah chcete lokalizovať?",

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

@@ -10,6 +10,7 @@ const fs = require('fs');
 const _ = require('lodash');
 const { stripIndent } = require('common-tags');
 const ExpressSessionCookie = require('express-session/session/cookie');
+const path = require('path');
 
 const apostropheI18nDebugPlugin = {
   type: 'postProcessor',
@@ -46,6 +47,7 @@ module.exports = {
     }
   },
   async init(self) {
+    self.defaultNamespace = 'default';
     self.namespaces = {};
     self.debug = process.env.APOS_DEBUG_I18N ? true : self.options.debug;
     self.show = process.env.APOS_SHOW_I18N ? true : self.options.show;
@@ -83,7 +85,7 @@ module.exports = {
         // Nunjucks and Vue will already do this
         escapeValue: false
       },
-      defaultNS: 'default',
+      defaultNS: self.defaultNamespace,
       debug: self.debug
     });
     if (self.show) {
@@ -380,21 +382,65 @@ module.exports = {
       // Add the i18next resources provided by the specified module,
       // merging with any existing phrases for the same locales and namespaces
       addResourcesForModule(module) {
-        if (!module.options.i18n) {
-          return;
-        }
-        const ns = module.options.i18n.ns || 'default';
+        self.addDefaultResourcesForModule(module);
+        self.addNamespacedResourcesForModule(module);
+      },
+      // Automatically adds any localizations found in .json files in the main `i18n` subdirectory
+      // of a module.
+      //
+      // These are added to the `default` namespace, unless the legacy `i18n.ns` option is set
+      // for the module (not the preferred way, use namespace subdirectories in new projects).
+      addDefaultResourcesForModule(module) {
+        const ns = (module.options.i18n && module.options.i18n.ns) || 'default';
         self.namespaces[ns] = self.namespaces[ns] || {};
-        self.namespaces[ns].browser = self.namespaces[ns].browser || !!module.options.i18n.browser;
+        self.namespaces[ns].browser = self.namespaces[ns].browser || (module.options.i18n && module.options.i18n.browser);
         for (const entry of module.__meta.chain) {
-          const localizationsDir = `${entry.dirname}/i18n`;
-          if (!fs.existsSync(localizationsDir)) {
-            continue;
+          const localizationsDir = path.join(entry.dirname, 'i18n');
+          if (!self.defaultLocalizationsDirsAdded.has(localizationsDir)) {
+            self.defaultLocalizationsDirsAdded.add(localizationsDir);
+            if (!fs.existsSync(localizationsDir)) {
+              continue;
+            }
+            for (const localizationFile of fs.readdirSync(localizationsDir)) {
+              if (!localizationFile.endsWith('.json')) {
+                // Likely a namespace subdirectory
+                continue;
+              }
+              const data = JSON.parse(fs.readFileSync(path.join(localizationsDir, localizationFile)));
+              const locale = localizationFile.replace('.json', '');
+              self.i18next.addResourceBundle(locale, ns, data, true, true);
+            }
           }
-          for (const localizationFile of fs.readdirSync(localizationsDir)) {
-            const data = JSON.parse(fs.readFileSync(`${localizationsDir}/${localizationFile}`));
-            const locale = localizationFile.replace('.json', '');
-            self.i18next.addResourceBundle(locale, ns, data, true, true);
+        }
+      },
+      // Automatically adds any localizations found in subdirectories of the main `i18n`
+      // subdirectory of a module. The subdirectory's name is treated as an i18n namespace
+      // name.
+      addNamespacedResourcesForModule(module) {
+        for (const entry of module.__meta.chain) {
+          const metadata = module.__meta.i18n[entry.name] || {};
+          const localizationsDir = `${entry.dirname}/i18n`;
+          if (!self.namespacedLocalizationsDirsAdded.has(localizationsDir)) {
+            self.namespacedLocalizationsDirsAdded.add(localizationsDir);
+            if (!fs.existsSync(localizationsDir)) {
+              continue;
+            }
+            for (const ns of fs.readdirSync(localizationsDir)) {
+              if (ns.endsWith('.json')) {
+                // A JSON file for the default namespace, already handled
+                continue;
+              }
+              self.namespaces[ns] = self.namespaces[ns] || {};
+              self.namespaces[ns].browser = self.namespaces[ns].browser ||
+                (metadata[ns] && metadata[ns].browser);
+              const namespaceDir = path.join(localizationsDir, ns);
+              for (const localizationFile of fs.readdirSync(namespaceDir)) {
+                const fullLocalizationFile = path.join(namespaceDir, localizationFile);
+                const data = JSON.parse(fs.readFileSync(fullLocalizationFile));
+                const locale = localizationFile.replace('.json', '');
+                self.i18next.addResourceBundle(locale, ns, data, true, true);
+              }
+            }
           }
         }
       },
@@ -402,6 +448,8 @@ module.exports = {
       // itself, called by init. Later modules call addResourcesForModule(self),
       // making phrases available gradually as Apostrophe starts up
       addInitialResources() {
+        self.defaultLocalizationsDirsAdded = new Set();
+        self.namespacedLocalizationsDirsAdded = new Set();
         for (const module of Object.values(self.apos.modules)) {
           self.addResourcesForModule(module);
         }
@@ -493,6 +541,7 @@ module.exports = {
           i18n,
           locale: req.locale,
           defaultLocale: self.defaultLocale,
+          defaultNamespace: self.defaultNamespace,
           locales: self.locales,
           debug: self.debug,
           show: self.show,