apostrophe 3.11.0 → 3.12.0

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 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
@@ -9,6 +30,7 @@
 ### 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
 
@@ -16,6 +38,7 @@
 * 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
 

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/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/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',
@@ -380,21 +381,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 +447,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);
         }

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

@@ -29,10 +29,20 @@ const _ = require('lodash');
 
 module.exports = {
 
-  cascades: [ 'csrfExceptions' ],
-
   init(self) {
     self.apos = self.options.apos;
+    const capturedSections = [
+      'queries',
+      'extendQueries',
+      'icons'
+    ];
+    for (const section of capturedSections) {
+      // Unparsed sections are now captured in __meta, promote
+      // these to the top level to maintain bc. For new unparsed
+      // sections we'll leave them in `__meta` to avoid bc breaks
+      // with project-level properties of the module
+      self[section] = self.__meta[section];
+    }
     // all apostrophe modules are properties of self.apos.modules.
     // Those with an alias are also properties of self.apos
     self.apos.modules[self.__meta.name] = self;

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

@@ -63,7 +63,7 @@ module.exports = {
         const doc = (docOrType && docOrType._id) ? docOrType : null;
         const manager = type && self.apos.doc.getManager(type);
         if (type && !manager) {
-          self.apos.util.warn(`A permission.can() call was made with a type that has no manager: ${type}`);
+          self.apos.util.warn('A permission.can() call was made with a type that has no manager:', type);
           return false;
         }
         if (action === 'view') {

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

@@ -566,7 +566,7 @@ module.exports = {
       },
       //
       // Update a piece. Convenience wrapper for `apos.doc.insert`.
-      // Returns the piece. `beforeInsert`, `beforeSave`, `afterInsert`
+      // Returns the piece. `beforeUpdate`, `beforeSave`, `afterUpdate`
       // and `afterSave` async events are emitted by this module.
       async update(req, piece, options) {
         return self.apos.doc.update(req, piece, options);

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

@@ -18,7 +18,7 @@ const _ = require('lodash');
 const dayjs = require('dayjs');
 const tinycolor = require('tinycolor2');
 const { klona } = require('klona');
-const { stripIndent } = require('common-tags');
+const { stripIndents } = require('common-tags');
 
 module.exports = {
   options: {
@@ -74,6 +74,22 @@ module.exports = {
           return true;
         }
         return _.isEqual(one[field.name], two[field.name]);
+      },
+      validate: function (field, options, warn, fail) {
+        if (field.options && field.options.widgets) {
+          for (const name of Object.keys(field.options.widgets)) {
+            if (!self.apos.modules[`${name}-widget`]) {
+              if (name.match(/-widget$/)) {
+                warn(stripIndents`
+                  Do not include "-widget" in the name when configuring a widget in an area field.
+                  Apostrophe will automatically add "-widget" when looking for the right module.
+                `);
+              } else {
+                warn(`Nonexistent widget type name ${name} in area field.`);
+              }
+            }
+          }
+        }
       }
     });
 
@@ -2247,7 +2263,7 @@ module.exports = {
           self.apos.util.error(format(s));
         }
         function format(s) {
-          return stripIndent`
+          return stripIndents`
             ${options.type} ${options.subtype}, ${field.type} field "${field.name}":
 
             ${s}

package/modules/@apostrophecms/schema/ui/apos/components/AposInputArea.vue

@@ -39,11 +39,7 @@ export default {
   mixins: [ AposInputMixin ],
   data () {
     return {
-      next: this.value.data || {
-        metaType: 'area',
-        _id: cuid(),
-        items: []
-      },
+      next: this.value.data || this.getEmptyValue(),
       error: false,
       // This is just meant to be sufficient to prevent unintended collisions
       // in the UI between id attributes
@@ -66,6 +62,17 @@ export default {
     }
   },
   methods: {
+    getEmptyValue() {
+      return {
+        metaType: 'area',
+        _id: cuid(),
+        items: []
+      };
+    },
+    watchValue () {
+      this.error = this.value.error;
+      this.next = this.value.data || this.getEmptyValue();
+    },
     validate(value) {
       if (this.field.required) {
         if (!value.items.length) {

package/modules/@apostrophecms/schema/ui/apos/components/AposInputCheckboxes.vue

@@ -32,6 +32,10 @@ export default {
     getChoiceId(uid, value) {
       return uid + value.replace(/\s/g, '');
     },
+    watchValue () {
+      this.error = this.value.error;
+      this.next = this.value.data || [];
+    },
     validate(values) {
       // The choices and values should always be arrays.
       if (!Array.isArray(this.field.choices) || !Array.isArray(values)) {

package/modules/@apostrophecms/ui/ui/apos/lib/i18next.js

@@ -23,6 +23,23 @@ export default {
       debug: i18n.debug,
       interpolation: {
         escapeValue: false
+      },
+      appendNamespaceToMissingKey: true,
+      parseMissingKeyHandler (key) {
+        // We include namespaces with unrecognized l10n keys using
+        // `appendNamespaceToMissingKey: true`. This passes strings containing
+        // colons that were never meant to be localized through to the UI.
+        //
+        // Strings that do not include colons ("Content area") are given the
+        // default namespace by i18next ("translation," by default). Here we
+        // check if the key starts with that default namespace, meaning it
+        // belongs to no other registered namespace, then remove that default
+        // namespace before passing this through to be processed and displayed.
+        if (key.startsWith(`${this.defaultNS[0]}:`)) {
+          return key.slice(this.defaultNS[0].length + 1);
+        } else {
+          return key;
+        }
       }
     });
 

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

@@ -936,15 +936,6 @@ module.exports = {
         });
       },
 
-      // If propertyName is _id, then the keys in the returned
-      // object will be the ids of each object in arr,
-      // and the values will be the corresponding objects.
-      // You may index by any property name.
-
-      indexBy: function(arr, propertyName) {
-        return _.indexBy(arr, propertyName);
-      },
-
       // Find all the array elements, if any, that have the specified value for
       // the specified property.
 
@@ -1061,11 +1052,14 @@ module.exports = {
 
         function groupByArray(items, arrayName) {
           const results = {};
+          // looping over each item in the original array
           _.each(items, function(item) {
+            // looping over each item in the array within the top level item
             _.each(item[arrayName] || [], function(inner) {
               if (!results[inner]) {
                 results[inner] = [];
               }
+              // grouping top level items on the sub properties
               results[inner].push(item);
             });
           });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apostrophe",
-  "version": "3.11.0",
+  "version": "3.12.0",
   "description": "The Apostrophe Content Management System.",
   "main": "index.js",
   "scripts": {

package/test/modules/base-type/i18n/custom/en.json

@@ -0,0 +1,4 @@
+{
+  "customTestOne": "Custom Test One From Base Type",
+  "customTestTwo": "Custom Test Two From Base Type"
+}

package/test/modules/base-type/i18n/en.json

@@ -0,0 +1,3 @@
+{
+  "defaultTestOne": "Default Test One"
+}

package/test/modules/nested-module-subdirs/example1/index.js

@@ -0,0 +1,5 @@
+module.exports = {
+  init(self) {
+    self.initialized = true;
+  }
+};

package/test/modules/nested-module-subdirs/modules.js

@@ -0,0 +1,7 @@
+module.exports = {
+  example1: {
+    options: {
+      folderLevelOption: true
+    }
+  }
+};

package/test/modules/subtype/i18n/custom/en.json

@@ -0,0 +1,4 @@
+{
+  "customTestOne": "Custom Test One From Subtype",
+  "customTestThree": "Custom Test Three From Subtype"
+}

package/test/modules/subtype/index.js

@@ -0,0 +1,7 @@
+module.exports = {
+  i18n: {
+    custom: {
+      browser: true
+    }
+  }
+};

package/test/static-i18n.js

@@ -33,9 +33,19 @@ describe('static i18n', function() {
         'apos-fr': {
           options: {
             i18n: {
+              // Legacy technique must work
               ns: 'apostrophe'
             }
           }
+        },
+        // A base class that contributes some namespaced phrases in the new style way (subdirs)
+        'base-type': {
+          instantiate: false
+        },
+        // Also contributes namespaced phrases in the new style way (subdirs)
+        // plus default locale phrases in the root i18n folder
+        subtype: {
+          extend: 'base-type'
         }
       }
     });
@@ -60,4 +70,22 @@ describe('static i18n', function() {
     assert.strictEqual(apos.task.getReq({ locale: 'fr' }).t('apostrophe:richTextAlignCenter'), 'Aligner Le Centre');
   });
 
+  it('should fetch default locale phrases from main i18n dir with no i18n option necessary', function() {
+    assert.strictEqual(apos.task.getReq().t('defaultTestOne'), 'Default Test One');
+  });
+
+  it('should fetch custom locale phrases from corresponding subdir', function() {
+    assert.strictEqual(apos.task.getReq().t('custom:customTestTwo'), 'Custom Test Two From Base Type');
+    assert.strictEqual(apos.task.getReq().t('custom:customTestThree'), 'Custom Test Three From Subtype');
+  });
+
+  it('last appearance in inheritance + configuration order wins', function() {
+    assert.strictEqual(apos.task.getReq().t('custom:customTestOne'), 'Custom Test One From Subtype');
+  });
+
+  it('should honor the browser: true flag in the i18n section of an index.js file', function() {
+    const browserData = apos.i18n.getBrowserData(apos.task.getReq());
+    assert.strictEqual(browserData.i18n.en.custom.customTestOne, 'Custom Test One From Subtype');
+  });
+
 });

package/test/with-nested-module-subdirs.js

@@ -0,0 +1,32 @@
+const t = require('../test-lib/test.js');
+const assert = require('assert');
+
+describe('With Nested Module Subdirs', function() {
+  this.timeout(t.timeout);
+
+  let apos;
+
+  after(function () {
+    return t.destroy(apos);
+  });
+
+  /// ///
+  // EXISTENCE
+  /// ///
+
+  it('should initialize', async function() {
+    apos = await t.create({
+      root: module,
+      nestedModuleSubdirs: true,
+      modules: {
+        example1: {}
+      }
+    });
+    assert(apos.modules.example1);
+    // With nestedModuleSubdirs switched on, the index.js should be found,
+    // and modules.js should be loaded
+    assert(apos.modules.example1.options.folderLevelOption);
+    assert(apos.modules.example1.initialized);
+  });
+
+});

package/test/without-nested-module-subdirs.js

@@ -0,0 +1,31 @@
+const t = require('../test-lib/test.js');
+const assert = require('assert');
+
+describe('Without Nested Module Subdirs', function() {
+  this.timeout(t.timeout);
+
+  let apos;
+
+  after(function () {
+    return t.destroy(apos);
+  });
+
+  /// ///
+  // EXISTENCE
+  /// ///
+
+  it('should initialize', async function() {
+    apos = await t.create({
+      root: module,
+      modules: {
+        example1: {}
+      }
+    });
+    assert(apos.modules.example1);
+    // Should fail because we didn't turn on nestedModuleSubdirs,
+    // so the index.js was not found and modules.js was not loaded
+    assert(!apos.modules.example1.options.folderLevelOption);
+    assert(!apos.modules.example1.initialized);
+  });
+
+});