apostrophe 3.58.1 → 3.59.0

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## 3.59.0 (2023-11-03)
+
+### Changes
+
+* Webpack warnings about package size during the admin UI build process have been turned off by default. Warnings are still enabled for the public build, where a large bundle can be problematic for SEO.
+
+### Fixes
+
+* Apostrophe warns you if you have more than one piece page for the same piece type and you have not overridden `chooseParentPage`
+to help Apostrophe decide which page is suitable as the `_url` of each piece. Beginning with this release, Apostrophe can recognize
+when you have chosen to do this via `extendMethods`, so that you can call `_super()` to fall back to the default implementation without
+receiving this warning. The default implementation still just returns the first page found, but always following the
+`_super()` pattern here opens the door to npm modules that `improve` `@apostrophecms/piece-page` to do something more
+sophisticated by default.
+* `newInstance` always returns a reasonable non-null empty value for area and
+object fields in case the document is inserted without being passed through
+the editor, e.g. in a parked page like the home page. This simplifies
+the new external front feature.
+
+### Adds
+
+* An adapter for Astro is under development with support from Michelin.
+Starting with this release, adapters for external fronts, i.e. "back for front"
+frameworks such as Astro, may now be implemented more easily. Apostrophe recognizes the
+`x-requested-with: AposExternalFront` header and the `apos-external-front-key` header.
+If both are present and `apos-external-front-key` matches the `APOS_EXTERNAL_FRONT_KEY`
+environment variable, then Apostrophe returns JSON in place of a normal page response.
+This mechanism is also available for the `render-widget` route.
+* Like `type`, `metaType` is always included in projections. This helps
+ensure that `apos.util.getManagerOf()` can be used on any object returned
+by the Apostrophe APIs.
+
 ## 3.58.1 (2023-10-18)
 
 ### Security

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

@@ -68,6 +68,13 @@ module.exports = {
             return manager.loadIfSuitable(req, [ widget ]);
           }
           async function render() {
+            if (req.aposExternalFront) {
+              const result = {
+                ...req.data,
+                widget
+              };
+              return result;
+            }
             return self.renderWidget(req, type, widget, options);
           }
         }

package/modules/@apostrophecms/asset/lib/webpack/apos/webpack.config.js

@@ -24,6 +24,9 @@ module.exports = ({
 
   const pnpmModulePath = apos.isPnpm ? [ path.join(apos.selfDir, '../') ] : [];
   const config = {
+    performance: {
+      hints: false
+    },
     entry: importFile,
     // Ensure that the correct version of vue-loader is found
     context: __dirname,

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

@@ -1629,6 +1629,7 @@ module.exports = {
             const hasExclusion = Object.values(projection).some(value => !value);
             if (!_.isEmpty(projection) && !hasExclusion) {
               add.push('type');
+              add.push('metaType');
             }
 
             for (const [ key, val ] of Object.entries(projection)) {

package/modules/@apostrophecms/doc-type/ui/apos/components/AposDocEditor.vue

@@ -64,7 +64,7 @@
               :trigger-validation="triggerValidation"
               :utility-rail="false"
               :following-values="followingValues('other')"
-              :conditional-fields="conditionalFields('other')"
+              :conditional-fields="conditionalFields"
               :doc-id="docId"
               :value="docFields"
               :server-errors="serverErrors"
@@ -89,7 +89,7 @@
             :trigger-validation="triggerValidation"
             :utility-rail="true"
             :following-values="followingUtils"
-            :conditional-fields="conditionalFields('utility')"
+            :conditional-fields="conditionalFields"
             :doc-id="docId"
             :value="docFields"
             @input="updateDocFields"
@@ -321,7 +321,7 @@ export default {
   },
   watch: {
     'docFields.data.type': {
-      handler(newVal, oldVal) {
+      handler(newVal) {
         if (this.moduleName !== '@apostrophecms/page') {
           return;
         }
@@ -342,6 +342,7 @@ export default {
   },
   async mounted() {
     this.modal.active = true;
+    await this.evaluateExternalConditions();
     // After computed properties become available
     this.saveMenu = this.computeSaveMenu();
     this.cancelDescription = {
@@ -349,6 +350,7 @@ export default {
       type: this.$t(this.moduleOptions.label)
     };
     if (this.docId) {
+      this.evaluateConditions();
       await this.loadDoc();
       try {
         if (this.manuallyPublished) {
@@ -372,6 +374,8 @@ export default {
       }
       this.modal.triggerFocusRefresh++;
     } else if (this.copyOfId) {
+      this.evaluateConditions();
+
       // Because the page or piece manager might give us just a projected,
       // minimum number of properties otherwise, and because we need to
       // make sure we use our preferred module to fetch the content
@@ -405,6 +409,7 @@ export default {
     } else {
       this.$nextTick(async () => {
         await this.loadNewInstance();
+        this.evaluateConditions();
         this.modal.triggerFocusRefresh++;
       });
     }
@@ -452,7 +457,7 @@ export default {
         const canEdit = docData._edit || this.moduleOptions.canEdit;
         this.readOnly = canEdit === false;
         if (canEdit && !await this.lock(this.getOnePath, this.docId)) {
-          await this.lockNotAvailable();
+          this.lockNotAvailable();
           return;
         }
       } catch {
@@ -679,6 +684,8 @@ export default {
         ...this.docFields.data,
         ...value.data
       };
+
+      this.evaluateConditions();
     },
     getAposSchema(field) {
       if (field.group.name === 'utility') {

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

@@ -162,6 +162,7 @@ module.exports = {
     self.createApp();
     self.prefix();
     self.trustProxy();
+    self.options.externalFrontKey = process.env.APOS_EXTERNAL_FRONT_KEY || self.options.externalFrontKey;
     if (self.options.baseUrl && !self.apos.baseUrl) {
       self.apos.util.error('WARNING: you have baseUrl set as an option to the `@apostrophecms/express` module.');
       self.apos.util.error('Set it as a global option (a property of the main object passed to apostrophe).');
@@ -249,6 +250,33 @@ module.exports = {
         url: '/api/v1',
         middleware: cors()
       },
+      externalFront(req, res, next) {
+        if (req.headers['x-requested-with'] !== 'AposExternalFront') {
+          return next();
+        }
+        if ((!self.options.externalFrontKey) || (req.headers['apos-external-front-key'] !== self.options.externalFrontKey)) {
+          if (!self.options.externalFrontKey) {
+            self.logError('externalFrontNotEnabled', 'An attempt was made to integrate an external front but the externalFrontKey option has not been set on the @apostrophecms/express module');
+          } else {
+            self.logError('externalFrontKeyInvalid', 'An attempt was made to integrate an external front but the apos-external-front-key header was missing or did not match the externalFrontKey option set on the @apostrophecms/express module');
+          }
+          return res.status(403).send('forbidden');
+        }
+        req.aposExternalFront = true;
+        res.redirect = function(...args) {
+          // The external front end needs to issue the actual redirect,
+          // not us
+          // Per Express handling of 1 arg versus 2
+          const status = args.length > 1 ? args[0] : 302;
+          const url = args[args.length - 1];
+          return res.send({
+            redirect: true,
+            url,
+            status
+          });
+        };
+        return next();
+      },
       attachUtilityMethods(req, res, next) {
         // We apply the super pattern variously to res.redirect,
         // make sure the original version is always available

package/modules/@apostrophecms/modal/ui/apos/mixins/AposDocErrorsMixin.js

@@ -4,7 +4,6 @@ export default {
   data: () => ({
     fieldErrors: {},
     errorCount: 0
-
   }),
   mounted () {
     this.prepErrors();
@@ -28,17 +27,19 @@ export default {
           }
         });
       }
+
       this.updateErrorCount();
     },
     updateErrorCount() {
       let count = 0;
-      for (const key in this.fieldErrors) {
-        for (const errKey in this.fieldErrors[key]) {
-          if (this.fieldErrors[key][errKey]) {
+      for (const group in this.fieldErrors) {
+        for (const field in this.fieldErrors[group]) {
+          if (this.fieldErrors[group][field]) {
             count++;
           }
         }
       }
+
       this.errorCount = count;
     },
     prepErrors() {

package/modules/@apostrophecms/modal/ui/apos/mixins/AposEditorMixin.js

@@ -15,7 +15,9 @@
  */
 
 import { klona } from 'klona';
-import { evaluateExternalConditions, conditionalFields } from 'Modules/@apostrophecms/schema/lib/conditionalFields.js';
+import {
+  evaluateExternalConditions, getConditionalFields, getConditionTypesObject
+} from 'Modules/@apostrophecms/schema/lib/conditionalFields.js';
 
 export default {
   data() {
@@ -27,7 +29,8 @@ export default {
       restoreOnly: false,
       readOnly: false,
       changed: [],
-      externalConditionsResults: {}
+      externalConditionsResults: getConditionTypesObject(),
+      conditionalFields: getConditionTypesObject()
     };
   },
 
@@ -57,10 +60,6 @@ export default {
     }
   },
 
-  async created() {
-    await this.evaluateExternalConditions();
-  },
-
   methods: {
     // Evaluate the external conditions found in each field
     // via API calls -made in parallel for performance-
@@ -129,8 +128,8 @@ export default {
     // the returned object will contain properties only for conditional fields
     // in that category, although they may be conditional upon fields in either
     // category.
-    conditionalFields(followedByCategory) {
-      return conditionalFields(
+    getConditionalFields(followedByCategory) {
+      return getConditionalFields(
         this.schema,
         this.getFieldsByCategory(followedByCategory),
         // currentDoc for arrays, docFields for all other editors
@@ -139,6 +138,10 @@ export default {
       );
     },
 
+    evaluateConditions() {
+      this.conditionalFields = this.getConditionalFields();
+    },
+
     // Overridden by components that split the fields into several AposSchemas
     getFieldValue(name) {
       return this.docFields.data[name];

package/modules/@apostrophecms/modal/ui/apos/mixins/AposModalTabsMixin.js

@@ -46,14 +46,15 @@ export default {
       const tabs = [];
       for (const key in this.groups) {
         if (key !== 'utility') {
-          // AposRelationshipEditor does not implement AposEditorMixin with the function conditionalFields
-          const conditionalFields = this.conditionalFields?.('other') || [];
+          // AposRelationshipEditor does not implement AposEditorMixin with the function getConditionalFields
           const fields = this.groups[key].fields;
           tabs.push({
             name: key,
             label: this.groups[key].label,
             fields,
-            isVisible: fields.some(field => conditionalFields[field] !== false)
+            isVisible: this.conditionalFields?.if
+              ? fields.some(field => this.conditionalFields.if[field] !== false)
+              : true
           });
         }
       }

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

@@ -423,6 +423,12 @@ module.exports = {
       // for this part of the behavior of sendPage.
 
       async renderPage(req, template, data) {
+        if (req.aposExternalFront) {
+          await self.apos.template.annotateDataForExternalFront(req, template, data);
+          self.apos.template.pruneDataForExternalFront(req, template, data);
+          // Reply with JSON
+          return data;
+        }
         return self.apos.template.renderPageForModule(req, template, data, self);
       },
 

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

@@ -40,7 +40,7 @@ module.exports = {
     self.enableAddUrlsToPieces();
   },
   methods(self) {
-    return {
+    const methods = {
 
       // Extend this method for your piece type to call additional
       // query builders by default.
@@ -212,8 +212,11 @@ module.exports = {
       // for their design.
 
       chooseParentPage(pages, piece) {
-        if (pages.length > 1) {
-          self.apos.util.warnDevOnce(`${self.__meta.name}/chooseParentPage`, `Your site has more than one ${self.name} page, but does not override the chooseParentPage method in ${self.__meta.name} to choose the right one for individual ${self.pieces.name}. You should also override filterByIndexPage. for ${self.pieces.name} will point to an arbitrarily chosen page.`);
+        // Complain if this method is called with more than one page without an
+        // extension to make it smart enough to presumably do something intelligent
+        // in that situation. Don't complain though if this is just a call to _super
+        if ((self.originalChooseParentPage === self.chooseParentPage) && (pages.length > 1)) {
+          self.apos.util.warnDevOnce(`${self.__meta.name}/chooseParentPage`, `Your site has more than one ${self.name} page, but does not extend the chooseParentPage\nmethod in ${self.__meta.name} to choose the right one for individual ${self.pieces.name}. You should also extend filterByIndexPage.\nOtherwise URLs for each ${self.pieces.name} will point to an arbitrarily chosen page.`);
         }
         return pages[0];
       },
@@ -309,6 +312,9 @@ module.exports = {
         }
       }
     };
+
+    self.originalChooseParentPage = methods.chooseParentPage;
+    return methods;
   },
   extendMethods(self) {
     return {

package/modules/@apostrophecms/rich-text-widget/ui/apos/components/AposImageControlDialog.vue

@@ -20,7 +20,8 @@
         :key="lastSelectionTime"
         :generation="generation"
         :following-values="followingValues()"
-        :conditional-fields="conditionalFields()"
+        :conditional-fields="conditionalFields"
+        @input="evaluateConditions()"
       />
       <footer class="apos-image-control__footer">
         <AposButton
@@ -29,9 +30,11 @@
           :modifiers="formModifiers"
         />
         <AposButton
-          type="primary" label="apostrophe:save"
-          @click="save"
+          type="primary"
+          label="apostrophe:save"
           :modifiers="formModifiers"
+          :disabled="docFields.hasErrors"
+          @click="save"
         />
       </footer>
     </AposContextMenuDialog>
@@ -112,6 +115,10 @@ export default {
       }
     }
   },
+  async mounted() {
+    await this.evaluateExternalConditions();
+    this.evaluateConditions();
+  },
   methods: {
     cancel() {
       this.$emit('cancel');

package/modules/@apostrophecms/rich-text-widget/ui/apos/components/AposTiptapAnchor.vue

@@ -42,7 +42,8 @@
           :key="lastSelectionTime"
           :generation="generation"
           :following-values="followingValues()"
-          :conditional-fields="conditionalFields()"
+          :conditional-fields="conditionalFields"
+          @input="evaluateConditions()"
         />
         <footer class="apos-anchor-control__footer">
           <AposButton
@@ -139,6 +140,10 @@ export default {
       }
     }
   },
+  async mounted() {
+    await this.evaluateExternalConditions();
+    this.evaluateConditions();
+  },
   methods: {
     removeAnchor() {
       this.docFields.data = {};

package/modules/@apostrophecms/rich-text-widget/ui/apos/components/AposTiptapLink.vue

@@ -43,7 +43,8 @@
           :key="lastSelectionTime"
           :generation="generation"
           :following-values="followingValues()"
-          :conditional-fields="conditionalFields()"
+          :conditional-fields="conditionalFields"
+          @input="evaluateConditions()"
         />
         <footer class="apos-link-control__footer">
           <AposButton
@@ -52,9 +53,11 @@
             :modifiers="formModifiers"
           />
           <AposButton
-            type="primary" label="apostrophe:save"
-            @click="save"
+            type="primary"
+            label="apostrophe:save"
             :modifiers="formModifiers"
+            :disabled="docFields.hasErrors"
+            @click="save"
           />
         </footer>
       </AposContextMenuDialog>
@@ -145,6 +148,7 @@ export default {
           name: 'href',
           label: this.$t('apostrophe:url'),
           type: 'string',
+          required: true,
           if: {
             linkTo: '_url'
           }
@@ -201,6 +205,10 @@ export default {
       }
     }
   },
+  async mounted() {
+    await this.evaluateExternalConditions();
+    this.evaluateConditions();
+  },
   methods: {
     removeLink() {
       this.docFields.data = {};
@@ -211,6 +219,7 @@ export default {
       if (this.hasSelection) {
         this.active = !this.active;
         this.populateFields();
+        this.evaluateConditions();
       }
     },
     close() {

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

@@ -374,6 +374,25 @@ module.exports = {
             // All fields should have an initial value in the database
             instance[field.name] = null;
           }
+          // A workaround specifically for areas. They must have a
+          // unique `_id` which makes `klona` a poor way to establish
+          // a default, and we don't pass functions in schema
+          // definitions, but top-level areas should always exist
+          // for reasonable results if the output of `newInstance`
+          // is saved without further editing on the front end
+          if ((field.type === 'area') && (!instance[field.name])) {
+            instance[field.name] = {
+              metaType: 'area',
+              items: [],
+              _id: self.apos.util.generateId()
+            };
+          }
+          // A workaround specifically for objects. These too need
+          // to have reasonable values in parked pages and any other
+          // situation where the data never passes through the UI
+          if ((field.type === 'object') && ((!instance[field.name]) || _.isEmpty(instance[field.name]))) {
+            instance[field.name] = self.newInstance(field.schema);
+          }
         }
         return instance;
       },
@@ -465,6 +484,78 @@ module.exports = {
         });
       },
 
+      async evaluateCondition(req, field, clause, destination, conditionalFields) {
+        for (const [ key, val ] of Object.entries(clause)) {
+          const destinationKey = _.get(destination, key);
+
+          if (key === '$or') {
+            const results = await Promise.all(val.map(clause => self.evaluateCondition(req, field, clause, destination, conditionalFields)));
+            const testResults = _.isPlainObject(results?.[0])
+              ? results.some(({ value }) => value)
+              : results.some((value) => value);
+            if (!testResults) {
+              return false;
+            }
+            continue;
+          } else if (val.$ne) {
+            // eslint-disable-next-line eqeqeq
+            if (val.$ne == destinationKey) {
+              return false;
+            }
+          }
+
+          // Handle external conditions:
+          //  - `if: { 'methodName()': true }`
+          //  - `if: { 'moduleName:methodName()': 'expected value' }`
+          // Checking if key ends with a closing parenthesis here to throw later if any argument is passed.
+          if (key.endsWith(')')) {
+            let externalConditionResult;
+
+            try {
+              externalConditionResult = await self.evaluateMethod(req, key, field.name, field.moduleName, destination._id);
+            } catch (error) {
+              throw self.apos.error('invalid', error.message);
+            }
+
+            if (externalConditionResult !== val) {
+              return false;
+            };
+
+            // Stop there, this is an external condition thus
+            // does not need to be checked against doc fields.
+            continue;
+          }
+
+          if (val.min && destinationKey < val.min) {
+            return false;
+          }
+          if (val.max && destinationKey > val.max) {
+            return false;
+          }
+
+          if (conditionalFields?.[key] === false) {
+            return false;
+          }
+
+          if (typeof val === 'boolean' && !destinationKey) {
+            return false;
+          }
+
+          // eslint-disable-next-line eqeqeq
+          if ((typeof val === 'string' || typeof val === 'number') && destinationKey != val) {
+            return false;
+          }
+        }
+
+        return true;
+      },
+
+      async isFieldRequired(req, field, destination) {
+        return field.requiredIf
+          ? await self.evaluateCondition(req, field, field.requiredIf, destination)
+          : field.required;
+      },
+
       // Convert submitted `data` object according to `schema`, sanitizing it
       // and populating the appropriate properties of `destination` with it.
       //
@@ -504,7 +595,16 @@ module.exports = {
 
           if (convert) {
             try {
-              await convert(req, field, data, destination);
+              const isRequired = await self.isFieldRequired(req, field, destination);
+              await convert(
+                req,
+                {
+                  ...field,
+                  required: isRequired
+                },
+                data,
+                destination
+              );
             } catch (error) {
               if (Array.isArray(error)) {
                 const invalid = self.apos.error('invalid', {
@@ -572,7 +672,7 @@ module.exports = {
           for (const field of schema) {
             if (field.if) {
               try {
-                const result = await evaluate(field.if, field.name, field.moduleName);
+                const result = await self.evaluateCondition(req, field, field.if, object, conditionalFields);
                 const previous = conditionalFields[field.name];
                 if (previous !== result) {
                   change = true;
@@ -598,55 +698,6 @@ module.exports = {
         } else {
           return true;
         }
-        async function evaluate(clause, fieldName, fieldModuleName) {
-          let result = true;
-          for (const [ key, val ] of Object.entries(clause)) {
-            if (key === '$or') {
-              const results = await Promise.all(val.map(clause => evaluate(clause, fieldName, fieldModuleName)));
-
-              if (!results.some(({ value }) => value)) {
-                result = false;
-                break;
-              }
-
-              // No need to go further here, the key is an "$or" condition...
-              continue;
-            }
-
-            // Handle external conditions:
-            //  - `if: { 'methodName()': true }`
-            //  - `if: { 'moduleName:methodName()': 'expected value' }`
-            // Checking if key ends with a closing parenthesis here to throw later if any argument is passed.
-            if (key.endsWith(')')) {
-              let externalConditionResult;
-
-              try {
-                externalConditionResult = await self.evaluateMethod(req, key, fieldName, fieldModuleName, object._id);
-              } catch (error) {
-                throw self.apos.error('invalid', error.message);
-              }
-
-              if (externalConditionResult !== val) {
-                result = false;
-                break;
-              };
-
-              // Stop there, this is an external condition thus
-              // does not need to be checked against doc fields.
-              continue;
-            }
-
-            if (conditionalFields[key] === false) {
-              result = false;
-              break;
-            }
-            if (val !== object[key]) {
-              result = false;
-              break;
-            }
-          }
-          return result;
-        }
       },
 
       async evaluateMethod(req, methodKey, fieldName, fieldModuleName, docId = null, optionalParenthesis = false) {
@@ -1246,6 +1297,9 @@ module.exports = {
         if (field.if && field.if.$or && !Array.isArray(field.if.$or)) {
           fail(`$or conditional must be an array of conditions. Current $or configuration: ${JSON.stringify(field.if.$or)}`);
         }
+        if (field.requiredIf && field.requiredIf.$or && !Array.isArray(field.requiredIf.$or)) {
+          fail(`$or conditional must be an array of conditions. Current $or configuration: ${JSON.stringify(field.requiredIf.$or)}`);
+        }
         if (!field.editPermission && field.permission) {
           field.editPermission = field.permission;
         }

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

@@ -65,13 +65,13 @@
                     :schema="schema"
                     :trigger-validation="triggerValidation"
                     :following-values="followingValues()"
-                    :conditional-fields="conditionalFields()"
+                    :conditional-fields="conditionalFields"
                     :value="currentDoc"
-                    @input="currentDocUpdate"
-                    @validate="triggerValidate"
                     :server-errors="currentDocServerErrors"
                     ref="schema"
                     :doc-id="docId"
+                    @input="currentDocUpdate"
+                    @validate="triggerValidate"
                   />
                 </div>
               </div>