apostrophe 3.23.0 → 3.24.0-alpha.2022071801

package/.github/workflows/main.yml

@@ -2,12 +2,12 @@
 
 name: Tests
 
-# Controls when the action will run. 
+# Controls when the action will run.
 on:
   push:
-    branches: [ '*' ]
+    branches: ["main"]
   pull_request:
-    branches: [ '*' ]
+    branches: ["*"]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -25,21 +25,21 @@ jobs:
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
-    - name: Git checkout
-      uses: actions/checkout@v2
+      - name: Git checkout
+        uses: actions/checkout@v2
 
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
 
-    - name: Start MongoDB
-      uses: supercharge/mongodb-github-action@1.3.0
-      with:
-        mongodb-version: ${{ matrix.mongodb-version }}
+      - name: Start MongoDB
+        uses: supercharge/mongodb-github-action@1.3.0
+        with:
+          mongodb-version: ${{ matrix.mongodb-version }}
 
-    - run: npm install
+      - run: npm install
 
-    - run: npm test
-      env:
-        CI: true
+      - run: npm test
+        env:
+          CI: true

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## Unreleased
+* Radio and Checkboxes schema inputs now support a server side `choices` function for supplying their choices array dynamically, like select supports. Future fields can opt into this functionality with the field flag `dynamicChoices`.
+
+## 3.24.0 (2022-07-06)`
+### Fixes
+
+* Unpinned tiptap as the tiptap team has made releases that resolve the packaging errors that caused us to pin it in 3.22.1.<F2>
+* Pinned `vue-loader` to the `15.9.x` minor release series for now. The `15.10.0` release breaks support for using `npm link` to develop the `apostrophe` module itself.
+
+## 3.24.0 (2022-07-06)
+
+### Adds
+
+* Handle `private: true` locale option in i18n module, preventing logged out users from accessing the content of a private locale.
+
+### Fixes
+
+* Fix missing title translation in the "Array Editor" component.
+* Add `follow: true` flag to `glob` functions (with `**` pattern) to allow registering symlink files and folders for nested modules
+* Fix disabled context menu for relationship fields editing ([#3820](https://github.com/apostrophecms/apostrophe/issues/3820))
+* In getReq method form the task module, extract the right `role` property from the options object.
+* Fix `def:` option in `array` fields, in order to be able to see the default items in the array editor modal
+
 ## 3.23.0 (2022-06-22)
 
 ### Adds

package/index.js

@@ -371,7 +371,7 @@ async function apostrophe(options, telemetry, rootSpan) {
     if (!options.nestedModuleSubdirs) {
       return;
     }
-    const configs = glob.sync(self.localModules + '/**/modules.js');
+    const configs = glob.sync(self.localModules + '/**/modules.js', { follow: true });
     _.each(configs, function(config) {
       try {
         _.merge(self.options.modules, require(config));

package/lib/locales.js

@@ -0,0 +1,43 @@
+const { stripIndent } = require('common-tags');
+
+module.exports = {
+  // Make sure they are adequately distinguished by
+  // hostname and prefix
+  verifyLocales(locales, baseUrl) {
+    const taken = {};
+    let hostnamesCount = 0;
+    for (const [ name, options ] of Object.entries(locales)) {
+      const hostname = options.hostname || '__none';
+      const prefix = options.prefix || '__none';
+      const key = `${hostname}:${prefix}`;
+
+      hostnamesCount += options.hostname ? 1 : 0;
+
+      if (taken[key]) {
+        throw new Error(stripIndent`
+          The locale "${name}" cannot be distinguished from earlier locales.
+          Make sure it is uniquely distinguished by its hostname option,
+          prefix option or a combination of the two.
+          One locale per site may be a default with neither hostname nor prefix,
+          and one locale per hostname may be a default for that hostname without a prefix.
+        `);
+      }
+      taken[key] = true;
+    }
+
+    if (
+      hostnamesCount > 0 &&
+      hostnamesCount < Object.keys(locales).length &&
+      !baseUrl
+    ) {
+      throw new Error(stripIndent`
+        If some of your locales have hostnames, then they all must have
+        hostnames, or your top-level baseUrl option must be set.
+
+        In development, you can set baseUrl to http://localhost:3000
+        for testing purposes. In production it should always be set
+        to a real base URL for the site.
+      `);
+    }
+  }
+};

package/lib/moog-require.js

@@ -60,7 +60,7 @@ module.exports = function(options) {
         // Fetching a list of index.js files on the first call and then searching it each time for
         // one that refers to the right type name shaves as much as 60 seconds off the startup
         // time in a large project, compared to using the glob cache feature
-        self._indexes = glob.sync(self.options.localModules + '/**/index.js');
+        self._indexes = glob.sync(self.options.localModules + '/**/index.js', { follow: true });
       }
       const matches = self._indexes.filter(function(index) {
         // Double-check that we're not confusing "@apostrophecms/asset" with "asset" by

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

@@ -11,6 +11,7 @@ const _ = require('lodash');
 const { stripIndent } = require('common-tags');
 const ExpressSessionCookie = require('express-session/session/cookie');
 const path = require('path');
+const { verifyLocales } = require('../../../lib/locales');
 
 const apostropheI18nDebugPlugin = {
   type: 'postProcessor',
@@ -218,7 +219,8 @@ module.exports = {
         } else {
           locale = self.matchLocale(req);
         }
-        const localeOptions = self.locales[locale];
+        const locales = self.filterPrivateLocales(req, self.locales);
+        const localeOptions = locales[locale];
         if (localeOptions.prefix) {
           // Remove locale prefix so URL parsing can proceed normally from here
           if (req.path === localeOptions.prefix) {
@@ -464,8 +466,9 @@ module.exports = {
       // possible the default locale is returned.
       matchLocale(req) {
         const hostname = req.hostname;
+        const locales = self.filterPrivateLocales(req, self.locales);
         let best = false;
-        for (const [ name, options ] of Object.entries(self.locales)) {
+        for (const [ name, options ] of Object.entries(locales)) {
           const matchedHostname = options.hostname
             ? (hostname === options.hostname.split(':')[0]) : null;
           const matchedPrefix = options.prefix
@@ -568,34 +571,7 @@ module.exports = {
             label: 'English'
           }
         };
-        const taken = {};
-        let hostnamesCount = 0;
-        for (const [ name, options ] of Object.entries(locales)) {
-          const key = (options.hostname || '__none') + ':' + (options.prefix || '__none');
-          hostnamesCount += (options.hostname ? 1 : 0);
-          if (taken[key]) {
-            throw new Error(stripIndent`
-              @apostrophecms/i18n: the locale ${name} cannot be distinguished from
-              earlier locales. Make sure it is uniquely distinguished by its hostname
-              option, prefix option or a combination of the two. One locale per site
-              may be a default with neither hostname nor prefix, and one locale per
-              hostname may be a default for that hostname without a prefix.
-            `);
-          }
-          taken[key] = true;
-        }
-        if ((hostnamesCount > 0) && (hostnamesCount < Object.keys(locales).length) && (!self.apos.options.baseUrl)) {
-          throw new Error(stripIndent`
-            If some of your locales have hostnames, then they all must have
-            hostnames, or your top-level baseUrl option must be set.
-
-            In development, you can set baseUrl to http://localhost:3000
-            for testing purposes. In production it should always be set
-            to a real base URL for the site.
-          `);
-        }
-        // Make sure they are adequately distinguished by
-        // hostname and prefix
+        verifyLocales(locales, self.apos.options.baseUrl);
         return locales;
       },
       sanitizeLocaleName(locale) {
@@ -656,6 +632,16 @@ module.exports = {
           }
           return res.redirect(corresponding._url);
         };
+      },
+      // Exclude private locales when logged out
+      filterPrivateLocales(req, locales) {
+        return req.user
+          ? locales
+          : Object.fromEntries(
+            Object
+              .entries(locales)
+              .filter(([ name, options ]) => options.private !== true)
+          );
       }
     };
   }

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

@@ -2,7 +2,10 @@ const _ = require('lodash');
 
 module.exports = {
   extend: '@apostrophecms/doc-type',
-  options: { name: '@apostrophecms/polymorphic' },
+  options: {
+    name: '@apostrophecms/polymorphic',
+    showPermissions: false
+  },
   routes(self) {
     return {
       post: {

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

@@ -1453,6 +1453,12 @@ module.exports = {
         _.each(self.apos.area.widgetManagers, function (manager, type) {
           self.register('widget', type, manager.schema);
         });
+      },
+
+      async getChoices(req, field) {
+        return typeof field.choices === 'string'
+          ? self.apos.modules[field.moduleName][field.choices](req)
+          : field.choices;
       }
 
     };
@@ -1466,7 +1472,7 @@ module.exports = {
           let choices = [];
           if (
             !field ||
-            field.type !== 'select' ||
+            !self.fieldTypes[field.type].dynamicChoices ||
             !(field.choices && typeof field.choices === 'string')
           ) {
             throw self.apos.error('invalid');

package/modules/@apostrophecms/schema/lib/addFieldTypes.js

@@ -231,7 +231,9 @@ module.exports = (self) => {
 
   self.addFieldType({
     name: 'checkboxes',
+    dynamicChoices: true,
     async convert(req, field, data, destination) {
+      const choices = await self.getChoices(req, field);
       if (typeof data[field.name] === 'string') {
         data[field.name] = self.apos.launder.string(data[field.name]).split(',');
 
@@ -241,14 +243,14 @@ module.exports = (self) => {
         }
 
         destination[field.name] = _.filter(data[field.name], function (choice) {
-          return _.includes(_.map(field.choices, 'value'), choice);
+          return _.includes(_.map(choices, 'value'), choice);
         });
       } else {
         if (!Array.isArray(data[field.name])) {
           destination[field.name] = [];
         } else {
           destination[field.name] = _.filter(data[field.name], function (choice) {
-            return _.includes(_.map(field.choices, 'value'), choice);
+            return _.includes(_.map(choices, 'value'), choice);
           });
         }
       }
@@ -303,13 +305,9 @@ module.exports = (self) => {
 
   self.addFieldType({
     name: 'select',
+    dynamicChoices: true,
     async convert(req, field, data, destination) {
-      let choices;
-      if ((typeof field.choices) === 'string') {
-        choices = await self.apos.modules[field.moduleName][field.choices](req);
-      } else {
-        choices = field.choices;
-      }
+      const choices = await self.getChoices(req, field);
       destination[field.name] = self.apos.launder.select(data[field.name], choices, field.def);
     },
     index: function (value, field, texts) {

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

@@ -1,7 +1,7 @@
 <template>
   <AposModal
     class="apos-array-editor" :modal="modal"
-    :modal-title="`Edit ${field.label}`"
+    :modal-title="modalTitle"
     @inactive="modal.active = false" @show-modal="modal.showModal = true"
     @esc="confirmAndCancel" @no-modal="$emit('safe-close')"
   >
@@ -113,6 +113,12 @@ export default {
   },
   emits: [ 'modal-result', 'safe-close' ],
   data() {
+    // Automatically add `_id` to default items
+    const items = this.items.map(item => ({
+      ...item,
+      _id: item._id || cuid()
+    }));
+
     return {
       currentId: null,
       currentDoc: null,
@@ -121,12 +127,16 @@ export default {
         type: 'overlay',
         showModal: false
       },
+      modalTitle: {
+        key: 'apostrophe:editType',
+        type: this.$t(this.field.label)
+      },
       titleFieldChoices: null,
       // If we don't clone, then we're making
       // permanent modifications whether the user
       // clicks save or not
-      next: klona(this.items),
-      original: klona(this.items),
+      next: klona(items),
+      original: klona(items),
       triggerValidation: false,
       minError: false,
       maxError: false,

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

@@ -8,7 +8,7 @@
     <template #body>
       <AposCheckbox
         :for="getChoiceId(uid, choice.value)"
-        v-for="choice in field.choices"
+        v-for="choice in choices"
         :key="choice.value"
         :id="getChoiceId(uid, choice.value)"
         :choice="choice"
@@ -21,10 +21,11 @@
 
 <script>
 import AposInputMixin from 'Modules/@apostrophecms/schema/mixins/AposInputMixin';
+import AposInputChoicesMixin from 'Modules/@apostrophecms/schema/mixins/AposInputChoicesMixin';
 
 export default {
   name: 'AposInputCheckboxes',
-  mixins: [ AposInputMixin ],
+  mixins: [ AposInputMixin, AposInputChoicesMixin ],
   beforeMount: function () {
     this.value.data = Array.isArray(this.value.data) ? this.value.data : [];
   },
@@ -38,7 +39,7 @@ export default {
     },
     validate(values) {
       // The choices and values should always be arrays.
-      if (!Array.isArray(this.field.choices) || !Array.isArray(values)) {
+      if (!Array.isArray(this.choices) || !Array.isArray(values)) {
         return 'malformed';
       }
 
@@ -48,7 +49,7 @@ export default {
 
       if (Array.isArray(values)) {
         values.forEach(chosen => {
-          if (!this.field.choices.map(choice => {
+          if (!this.choices.map(choice => {
             return choice.value;
           }).includes(chosen)) {
             return 'invalid';

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

@@ -8,7 +8,7 @@
     <template #body>
       <label
         class="apos-choice-label" :for="getChoiceId(uid, choice.value)"
-        v-for="choice in field.choices" :key="choice.value"
+        v-for="choice in choices" :key="choice.value"
         :class="{'apos-choice-label--disabled': field.readOnly}"
       >
         <input
@@ -43,12 +43,13 @@
 
 <script>
 import AposInputMixin from 'Modules/@apostrophecms/schema/mixins/AposInputMixin';
+import AposInputChoicesMixin from 'Modules/@apostrophecms/schema/mixins/AposInputChoicesMixin';
 import InformationIcon from 'vue-material-design-icons/Information.vue';
 
 export default {
   name: 'AposInputRadio',
   components: { InformationIcon },
-  mixins: [ AposInputMixin ],
+  mixins: [ AposInputMixin, AposInputChoicesMixin ],
   methods: {
     getChoiceId(uid, value) {
       return (uid + JSON.stringify(value)).replace(/\s+/g, '');
@@ -58,7 +59,7 @@ export default {
         return 'required';
       }
 
-      if (value && !this.field.choices.find(choice => choice.value === value)) {
+      if (value && !this.choices.find(choice => choice.value === value)) {
         return 'invalid';
       }
 
@@ -66,7 +67,7 @@ export default {
     },
     change(value) {
       // Allows expression of non-string values
-      this.next = this.field.choices.find(choice => choice.value === JSON.parse(value)).value;
+      this.next = this.choices.find(choice => choice.value === JSON.parse(value)).value;
     }
   }
 };

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

@@ -20,10 +20,11 @@
 
 <script>
 import AposInputMixin from 'Modules/@apostrophecms/schema/mixins/AposInputMixin';
+import AposInputChoicesMixin from 'Modules/@apostrophecms/schema/mixins/AposInputChoicesMixin';
 
 export default {
   name: 'AposInputSelect',
-  mixins: [ AposInputMixin ],
+  mixins: [ AposInputMixin, AposInputChoicesMixin ],
   props: {
     icon: {
       type: String,
@@ -37,34 +38,15 @@ export default {
     };
   },
   async mounted() {
-    let choices;
-    if (typeof this.field.choices === 'string') {
-      const action = this.options.action;
-      const response = await apos.http.get(
-        `${action}/choices`,
-        {
-          qs: {
-            fieldId: this.field._id
-          },
-          busy: true
-        }
-      );
-      if (response.choices) {
-        choices = response.choices;
-      }
-    } else {
-      choices = this.field.choices;
-    }
     // Add an null option if there isn't one already
-    if (!this.field.required && !choices.find(choice => {
+    if (!this.field.required && !this.choices.find(choice => {
       return choice.value === null;
     })) {
-      this.choices.push({
+      this.choices.unshift({
         label: '',
         value: null
       });
     }
-    this.choices = this.choices.concat(choices);
     this.$nextTick(() => {
       // this has to happen on nextTick to avoid emitting before schemaReady is
       // set in AposSchema

package/modules/@apostrophecms/schema/ui/apos/mixins/AposInputChoicesMixin.js

@@ -0,0 +1,32 @@
+/*
+* Provides prep work for fetching choices from the server
+* or defaulting to the choices provided with the field.
+*/
+
+export default {
+  data() {
+    return {
+      choices: []
+    };
+  },
+
+  async mounted() {
+    if (typeof this.field.choices === 'string') {
+      const action = this.options.action;
+      const response = await apos.http.get(
+        `${action}/choices`,
+        {
+          qs: {
+            fieldId: this.field._id
+          },
+          busy: true
+        }
+      );
+      if (response.choices) {
+        this.choices = response.choices;
+      }
+    } else {
+      this.choices = this.field.choices;
+    }
+  }
+};

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

@@ -287,9 +287,11 @@ module.exports = {
         };
         addCloneMethod(req);
         req.res.__ = req.__;
-        const { _role, ...properties } = options || {};
+        const { role: _role, ...properties } = options || {};
+
         Object.assign(req, properties);
         self.apos.i18n.setPrefixUrls(req);
+
         return req;
 
         function addCloneMethod(req) {

package/modules/@apostrophecms/ui/ui/apos/components/AposSlat.vue

@@ -34,7 +34,7 @@
           @item-clicked="$emit('item-clicked', item)"
           menu-placement="bottom-start"
           menu-offset="40, 10"
-          disabled="disabled"
+          :disabled="disabled"
         />
         <AposButton
           class="apos-slat__editor-btn"
@@ -48,7 +48,7 @@
           :icon-only="true"
           :modifiers="['inline']"
           @click="$emit('item-clicked', item)"
-          disabled="disabled"
+          :disabled="disabled"
         />
         <a
           class="apos-slat__control apos-slat__control--view"
@@ -169,7 +169,7 @@ export default {
   },
   computed: {
     itemSize() {
-      const size = this.item.length.size;
+      const size = this.item.length?.size;
       if (size < 1000000) {
         return `${(size / 1000).toFixed(0)}KB`;
       } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apostrophe",
-  "version": "3.23.0",
+  "version": "3.24.0-alpha.2022071801",
   "description": "The Apostrophe Content Management System.",
   "main": "index.js",
   "scripts": {
@@ -35,13 +35,13 @@
     "@babel/preset-env": "^7.16.7",
     "@opentelemetry/api": "^1.0.4",
     "@opentelemetry/semantic-conventions": "^1.0.1",
-    "@tiptap/extension-highlight": "2.0.0-beta.33",
-    "@tiptap/extension-link": "2.0.0-beta.38",
-    "@tiptap/extension-text-align": "2.0.0-beta.29",
-    "@tiptap/extension-text-style": "2.0.0-beta.23",
-    "@tiptap/extension-underline": "2.0.0-beta.23",
-    "@tiptap/starter-kit": "2.0.0-beta.185",
-    "@tiptap/vue-2": "2.0.0-beta.79",
+    "@tiptap/extension-highlight": "^2.0.0-beta.33",
+    "@tiptap/extension-link": "^2.0.0-beta.38",
+    "@tiptap/extension-text-align": "^2.0.0-beta.29",
+    "@tiptap/extension-text-style": "^2.0.0-beta.23",
+    "@tiptap/extension-underline": "^2.0.0-beta.23",
+    "@tiptap/starter-kit": "^2.0.0-beta.185",
+    "@tiptap/vue-2": "^2.0.0-beta.79",
     "autoprefixer": "^10.4.1",
     "babel-loader": "^8.2.5",
     "bluebird": "^3.7.2",
@@ -119,7 +119,7 @@
     "vue": "^2.6.14",
     "vue-advanced-cropper": "^1.10.1",
     "vue-click-outside-element": "^1.0.15",
-    "vue-loader": "^15.9.6",
+    "vue-loader": "~15.9.8",
     "vue-material-design-icons": "~4.12.1",
     "vue-style-loader": "^4.1.2",
     "vue-template-compiler": "^2.6.14",

package/test/caches.js

@@ -22,6 +22,11 @@ describe('Caches', function() {
   it('should allow us to store capuchin', async function() {
     await apos.cache.set('test', 'capuchin', { message: 'eek eek' });
   });
+  it('second cache can contain capuchin with a different value', async function() {
+    await apos.cache.set('test2', 'capuchin', { message: 'ook ook' });
+    assert.strictEqual((await apos.cache.get('test', 'capuchin')).message, 'eek eek');
+    assert.strictEqual((await apos.cache.get('test2', 'capuchin')).message, 'ook ook');
+  });
   it('should now contain capuchin', async function() {
     const monkey = await apos.cache.get('test', 'capuchin');
     assert(monkey);
@@ -33,4 +38,19 @@ describe('Caches', function() {
   it('should not contain capuchin anymore', async function() {
     assert(!(await apos.cache.get('test', 'capuchin')));
   });
+  it('but test2 cache still does contain capuchin', async function() {
+    assert.strictEqual((await apos.cache.get('test2', 'capuchin')).message, 'ook ook');
+  });
+  it('unique key index does block double insert in same namespace', async function() {
+    try {
+      await apos.cache.cacheCollection.insert({
+        name: 'test2',
+        key: 'capuchin'
+      });
+      // That's bad, we should be blocked
+      assert(false);
+    } catch (e) {
+      // That's good, we were blocked
+    }
+  });
 });

package/test/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "test",
+  "dependencies": {
+    "apostrophe": "^3.0.0",
+    "improve-global": "1.0.0",
+    "improve-piece-type": "1.0.0"
+  },
+  "devDependencies": {
+    "test-bundle": "1.0.0"
+  }
+}

package/test/pages.js

@@ -1229,10 +1229,11 @@ describe('Pages', function() {
         try {
           const publicUrl = generatePublicUrl(shareResponse);
           await apos.http.get(publicUrl, { fullResponse: true });
-          throw new Error('should have thrown 404 error');
         } catch (error) {
           assert(error.status === 404);
+          return;
         }
+        throw new Error('should have thrown 404 error');
       });
     });
   });

package/test/pieces.js

@@ -1818,10 +1818,11 @@ describe('Pieces', function() {
         try {
           const publicUrl = generatePublicUrl(shareResponse);
           await apos.http.get(publicUrl, { fullResponse: true });
-          throw new Error('should have thrown 404 error');
         } catch (error) {
           assert(error.status === 404);
+          return;
         }
+        throw new Error('should have thrown 404 error');
       });
     });
   });

package/test/static-i18n.js

@@ -21,6 +21,10 @@ describe('static i18n', function() {
               en: {},
               fr: {
                 prefix: '/fr'
+              },
+              es: {
+                prefix: '/es',
+                private: true
               }
             }
           }
@@ -88,4 +92,14 @@ describe('static i18n', function() {
     assert.strictEqual(browserData.i18n.en.custom.customTestOne, 'Custom Test One From Subtype');
   });
 
+  it('should return a 404 HTTP error code when a logged out user tries to access to a content in a private locale', async function() {
+    try {
+      await apos.http.get('/es');
+    } catch (error) {
+      assert(error.status === 404);
+      return;
+    }
+    throw new Error('should have thrown 404 error');
+  });
+
 });