apostrophe 3.53.0 → 3.55.0

package/CHANGELOG.md

@@ -1,5 +1,62 @@
 # Changelog
 
+## 3.55.0
+
+### Adds
+
+* Add `publicApiCheckAsync` wrapper method (and use it internally) to allow for overrides to do async permission checks of REST APIs. This feature doesn't introduce any breaking changes because the default implementation still invokes `publicApiCheck` in case developers have overridden it.
+
+### Fixes
+
+* Refresh schema field with same name in `AposDocEditor` when the schema changes.
+* Infer parent ID mode from the request when retrieving the parent (target) page to avoid `notfound`.
+* Log the actual REST API error message and not the one meant for the user.
+* Hide dash on autopublished pages title.
+
+## 3.54.0 (2023-08-16)
+
+### Adds
+
+* Add `@apostrophecms/log` module to allow structured logging. All modules have `logDebug`, `logInfo`, `logWarn` and `logError` methods now. See the [documentation](https://v3.docs.apostrophecms.org/guide/logging.html) for more details.
+* Add `@apostrophecms/settings` translations.
+* Add the ability to have custom modals for batch operations.
+* Add the possibility to display utility operations inside a 3-dots menu on the page manager, the same way it is done for the docs manager.
+* Custom context operations now accept a `moduleIf` property, which tests options at the module level
+the same way that `if` tests properties of the document to determine if the operation should be
+offered for a particular document. Note that not all options are passed to the front end unless
+`getBrowserData` is extended to suit the need.
+* Move Pages Manager modal business logic to a mixin.
+* Add `column.extraWidth` option (number) for `AposTreeHeader.vue` to allow control over the tree cell width.
+* Move `AposDocContextMenu.vue` business logic to a mixin.
+* Move Pages Manager modal business logic to a mixin. Add `column.extraWidth` option (number) for `AposTreeHeader.vue` to allow control over the tree cell width.
+
+### Changes
+
+* Rename misleading `projection` parameter into `options` in `self.find` method signature for
+`@apostrophecms/any-doc-type`, `@apostrophecms/any-page-type` & `@apostrophecms/piece-type`.
+**This was never really a projection in A3,** so it is not a backwards compatibility issue.
+* Hide save button during in-context editing if the document is autopublished.
+* Beginning with this release, the correct `moduleName` for typical
+actions on the context document is automatically passed to the
+modal associated with a custom context operation, unless `moduleName`
+is explicitly specified. The `moduleName` parameter to `addContextOperation`
+is no longer required and should not be passed at all in most cases
+(just pass the object argument). If you do wish to specify a `moduleName`
+to override that prop given to the modal, then it is recommended to pass
+it as a `moduleName` property of the object, not as a separate argument.
+For backwards compatibility the two-argument syntax is still permitted.
+
+### Fixes
+
+* Resolved data integrity issue with certain page tree operations by inferring the best peer to position the page relative to rather
+than attempting to remember the most recent move operation.
+* Fixes a downstream bug in the `getFieldsByCategory` method in the `AposEditorMixin.js` by checking for a property before accessing it.
+* In Nunjucks templates, `data.url` now includes any sitewide and locale URL prefixes. This fixes local prefixing for pagination of piece-type index pages.
+* Changes were detected in various fields such as integers, which caused the "Update" button to be active even when there was no actual modification in the doc.
+* Fix a bug that prevented adding multiple operations in the same batch operation group.
+* The `getTarget` method of the page module should use `findForEditing` to make sure it is able to see
+pages that would be filtered out of a public view by project level or npm module overrides.
+
 ## 3.53.0 (2023-08-03)
 
 ### Adds
@@ -33,7 +90,7 @@ their modal and a `docProps` object to map properties from the document
 to props of their choosing.
 * Adds support to add context labels in admin bar.
 * Adds support for admin UI language configuration in the `@apostrophecms/i18n` module. The new options allow control over the default admin UI language and configures the list of languages, that any individual logged in user can choose from. See the [documentation](https://v3.docs.apostrophecms.org/reference/modules/i18n.html) for more details.
-* Adds `adminLocale` User field to allow users to set their preferred admin UI language, but only when the `@apostrophecms/i18n` is configured accordingly (see above). 
+* Adds `adminLocale` User field to allow users to set their preferred admin UI language, but only when the `@apostrophecms/i18n` is configured accordingly (see above).
 * Adds `@apostrophecms/settings` module and a "Personal Settings" feature. See the [documentation](https://v3.docs.apostrophecms.org/reference/modules/settings.html) for more details.
 * Adds `$and` operator on `addContextOperation` `if` property in order to check multiple fields before showing or hiding a context operation.
 

package/defaults.js

@@ -1,5 +1,6 @@
 module.exports = {
   modules: {
+    '@apostrophecms/log': {},
     '@apostrophecms/error': {},
     '@apostrophecms/util': {},
     '@apostrophecms/i18n': {},

package/modules/@apostrophecms/admin-bar/ui/apos/components/TheAposContextModeAndSettings.vue

@@ -36,7 +36,7 @@
         :show-preview="false"
       />
       <AposButton
-        v-if="canSwitchToPreviewMode"
+        v-if="canSwitchToPreviewMode && !isAutopublished"
         class="apos-admin-bar__context-button"
         label="apostrophe:preview" :tooltip="{
           content: 'apostrophe:previewTooltip',
@@ -46,7 +46,7 @@
         @click="switchEditMode(false)"
       />
       <AposButton
-        v-if="editMode"
+        v-if="editMode && !isAutopublished"
         type="primary" :label="publishLabel"
         :disabled="!readyToPublish"
         class="apos-admin-bar__btn apos-admin-bar__context-button"
@@ -125,6 +125,9 @@ export default {
         }
       }
     },
+    isAutopublished() {
+      return this.context._aposAutopublish ?? (window.apos.modules[this.context.type].autopublish || false);
+    },
     hasBeenPublishedThisPageload() {
       return (this.context.lastPublishedAt > this.mountedAt) || ((this.context.submitted && this.context.submitted.at) > this.mountedAt);
     },

package/modules/@apostrophecms/admin-bar/ui/apos/components/TheAposContextTitle.vue

@@ -18,25 +18,30 @@
       <span class="apos-admin-bar__title__document-title">
         {{ context.title }}
       </span>
-      <span class="apos-admin-bar__title__separator">
-        —
-      </span>
-      <AposContextMenu
-        v-if="!isUnpublished"
-        class="apos-admin-bar__title__document"
-        :button="draftButton"
-        :menu="draftMenu"
-        :disabled="hasCustomUi || isUnpublished"
-        @item-clicked="switchDraftMode"
-        menu-offset="13, 10"
-        menu-placement="bottom-end"
-      />
-      <AposLabel
-        v-else
-        :label="'apostrophe:draft'"
-        :tooltip="'apostrophe:notYetPublished'"
-        :modifiers="['apos-is-warning', 'apos-is-filled']"
-      />
+      <div
+        v-if="!isAutopublished"
+        class="apos-admin-bar__title__context"
+      >
+        <span class="apos-admin-bar__title__separator">
+          —
+        </span>
+        <AposContextMenu
+          v-if="!isUnpublished"
+          class="apos-admin-bar__title__document"
+          :button="draftButton"
+          :menu="draftMenu"
+          :disabled="hasCustomUi || isUnpublished"
+          @item-clicked="switchDraftMode"
+          menu-offset="13, 10"
+          menu-placement="bottom-end"
+        />
+        <AposLabel
+          v-else
+          :label="'apostrophe:draft'"
+          :tooltip="'apostrophe:notYetPublished'"
+          :modifiers="['apos-is-warning', 'apos-is-filled']"
+        />
+      </div>
       <AposLabel
         class="apos-admin-bar__title-context-label"
         v-for="{id, label, tooltip = '', modifiers = []} in moduleOptions.contextLabels"
@@ -117,6 +122,9 @@ export default {
     },
     moduleOptions() {
       return window.apos.adminBar;
+    },
+    isAutopublished() {
+      return this.context._aposAutopublish ?? (window.apos.modules[this.context.type].autopublish || false);
     }
   },
   mounted() {
@@ -148,6 +156,7 @@ export default {
   align-items: center;
   white-space: nowrap;
 
+  &__context,
   &__document-title,
   &__separator {
     display: inline-flex;

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

@@ -2,8 +2,8 @@ module.exports = {
   extend: '@apostrophecms/doc-type',
   extendMethods(self) {
     return {
-      find(_super, req, criteria, projection) {
-        return _super(req, criteria, projection).type(false);
+      find(_super, req, criteria, options) {
+        return _super(req, criteria, options).type(false);
       }
     };
   }

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

@@ -59,8 +59,8 @@ module.exports = {
 
   extendMethods(self) {
     return {
-      find(_super, req, criteria, projection) {
-        return _super(req, criteria, projection).type(false).isPage(true);
+      find(_super, req, criteria, options) {
+        return _super(req, criteria, options).type(false).isPage(true);
       },
       // Returns a MongoDB projection object to be used when querying
       // for this type if all that is needed is a title for display

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

@@ -322,8 +322,7 @@ module.exports = {
           path: { $exists: 1 },
           slug: /^\//
         }).project({
-          path: 1,
-          aposLastTargetId: 1
+          path: 1
         }).toArray();
         for (const pair of pairs) {
           const [ from, to ] = pair;
@@ -386,15 +385,6 @@ module.exports = {
           }
           if (isPage) {
             for (const page of pages) {
-              if (page.aposLastTargetId === from) {
-                await self.apos.doc.db.updateOne({
-                  _id: page._id
-                }, {
-                  $set: {
-                    aposLastTargetId: to
-                  }
-                });
-              }
               if (page.path.includes(oldAposDocId)) {
                 await self.apos.doc.db.updateOne({
                   _id: page._id
@@ -1147,40 +1137,76 @@ module.exports = {
           'slug'
         ];
       },
-      // Add context menu operation to be used in AposDocContextMenu.
-      // Expected operation format is:
+
+      // Add a context menu operation to be offered in AposDocContextMenu, the
+      // "kebab menu" that provides extra operations on the current document or
+      // a document listed in a manager modal.
+      //
+      // The required format is:
+      //
       // {
       //   context: 'update',
       //   action: 'someAction',
       //   modal: 'ModalComponent',
-      //   label: 'Context Menu Label',
-      //   conditions: ['canEdit']
+      //   label: 'Context Menu Item Label',
+      //   conditions: ['canEdit'],
+      //   moduleName: 'some-specific-module'
       // }
-      // All properties are required except conditions.
-      // The only supported `context` for now is `update`.
+      //
+      // All properties are required except for `conditions`, `moduleName`,
+      // `modifiers` and `manuallyPublished`.
+      //
+      // Context operations are universal, e.g. they are displayed by the context
+      // menu no matter what the content type is, unless overridden by `conditions`.
+      //
       // `action` is the operation identifier and should be globally unique.
-      // Overriding existing custom actions is possible (the last wins).
-      // `modal` is the name of the modal component to be opened.
-      // `label` is the menu label to be shown when expanding the context menu.
-      // Additional optional `modifiers` property is supported - button modifiers
+      // For convenience, if several modules add an operation with the same `action`,
+      // it is only added once. This prevents duplicates if all subclasses of
+      // `doc-type` or `piece-type` register the same operation.
+      //
+      // `context` currently must be `update`.
+      //
+      // `modal` is the name of the modal component to be opened by the operation.
+      //
+      // `label` is the menu item label to be shown when expanding the context menu.
+      //
+      // An additional `moduleName` property is supported. If it is not given,
+      // it will be inferred from the `type` of the document in context, with all page
+      // types using the page module (not their type-specific module). This is almost
+      // always correct, therefore it only makes sense to pass an explicit
+      // `moduleName` option here if the action API should be invoked on a different module
+      // than expected.
+      //
+      // An additional optional `modifiers` property is supported - button modifiers
       // as supported by `AposContextMenu` (e.g. modifiers: [ 'danger' ]).
+      //
       // An optional `manuallyPublished` boolean property is supported - if true
       // the menu will be shown only for docs which have `autopublish: false` and
       // `localized: true` options.
-      // `conditions` defines the needed permission actions to be run on the current doc
-      // in order to display the operation.
-      // It must be an array containing one or multiple of these available values:
+      //
+      // `conditions` defines the circumstances under which the opetion should be displayed.
+      // If all `conditions` are not met, the item is not displayed for this particular
+      // document.
+      //
+      // `conditions` may be an array containing one or multiple of these values:
+      //
       // 'canPublish', 'canEdit', 'canDismissSubmission', 'canDiscardDraft',
       // 'canLocalize', 'canArchive', 'canUnpublish', 'canCopy', 'canRestore'.
-      addContextOperation(moduleName, operation) {
+
+      addContextOperation(operation) {
+        if (arguments.length === 2) {
+          // For backwards compatibility. `moduleName` is rarely needed
+          // so it should not be a separate argument in new code.
+          operation = {
+            ...arguments[1],
+            moduleName: arguments[0]
+          };
+        }
         validate(operation);
         self.contextOperations = [
           ...self.contextOperations
             .filter(op => op.action !== operation.action),
-          {
-            ...operation,
-            moduleName
-          }
+          operation
         ];
 
         function validate ({

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

@@ -415,7 +415,7 @@ module.exports = {
         }
       },
       addContextMenu() {
-        self.apos.doc.addContextOperation(self.__meta.name, {
+        self.apos.doc.addContextOperation({
           action: 'shareDraft',
           context: 'update',
           label: 'apostrophe:shareDraft',
@@ -1054,10 +1054,14 @@ module.exports = {
               });
             } else {
               // A page that is not the home page, being replicated for the first time
-              const lastTargetId = draft.aposLastTargetId;
-              let lastPosition = draft.aposLastPosition;
+              let { lastTargetId, lastPosition } = await self.apos.page.inferLastTargetIdAndPosition(draft);
               let localizedTargetId = lastTargetId.replace(`:${draft.aposLocale}`, `:${toLocale}:draft`);
-              const localizedTarget = await actionModule.find(toReq, self.apos.page.getIdCriteria(localizedTargetId)).archived(null).areas(false).relationships(false).toObject();
+              const localizedTarget = await actionModule
+                .find(toReq, self.apos.page.getIdCriteria(localizedTargetId))
+                .archived(null)
+                .areas(false)
+                .relationships(false)
+                .toObject();
               if (!localizedTarget) {
                 if ((lastPosition === 'firstChild') || (lastPosition === 'lastChild')) {
                   throw self.apos.error('notfound', req.t('apostrophe:parentNotLocalized'), {
@@ -1071,9 +1075,10 @@ module.exports = {
                     // Almost impossible (race conditions like someone removing it while we're in the modal)
                     throw self.apos.error('notfound');
                   }
-                  const localizedTarget = await actionModule.find(toReq, {
+                  const criteria = {
                     path: self.apos.page.getParentPath(originalTarget)
-                  }).archived(null).areas(false).relationships(false).toObject();
+                  };
+                  const localizedTarget = await actionModule.find(toReq, criteria).archived(null).areas(false).relationships(false).toObject();
                   if (!localizedTarget) {
                     throw self.apos.error('notfound', req.t('apostrophe:parentNotLocalized'), {
                       // Also provide as data for code that prefers to localize client side