apostrophe 3.53.0 → 3.55.0

package/modules/@apostrophecms/page/ui/apos/logic/AposPagesManager.js

@@ -0,0 +1,291 @@
+// Pages manager (tree) modal business logic.
+
+import AposModifiedMixin from 'Modules/@apostrophecms/ui/mixins/AposModifiedMixin';
+import AposArchiveMixin from 'Modules/@apostrophecms/ui/mixins/AposArchiveMixin';
+import AposPublishMixin from 'Modules/@apostrophecms/ui/mixins/AposPublishMixin';
+import AposDocsManagerMixin from 'Modules/@apostrophecms/modal/mixins/AposDocsManagerMixin';
+import { klona } from 'klona';
+
+export default {
+  name: 'AposPagesManager',
+  mixins: [ AposModifiedMixin, AposDocsManagerMixin, AposArchiveMixin, AposPublishMixin ],
+  emits: [ 'archive', 'search', 'safe-close', 'modal-result' ],
+  data() {
+
+    return {
+      moduleName: '@apostrophecms/page',
+      modal: {
+        active: false,
+        triggerFocusRefresh: 0,
+        type: 'slide',
+        showModal: false,
+        width: 'two-thirds'
+      },
+      pages: [],
+      pagesFlat: [],
+      options: {
+        columns: [
+          {
+            columnHeader: 'apostrophe:pageTitle',
+            property: 'title',
+            cellValue: 'title'
+          },
+          {
+            name: 'labels',
+            component: 'AposCellLabels'
+          },
+          {
+            columnHeader: 'apostrophe:lastEdited',
+            property: 'updatedAt',
+            component: 'AposCellLastEdited',
+            cellValue: 'updatedAt'
+          },
+          {
+            property: 'contextMenu',
+            component: 'AposCellContextMenu'
+          }
+        ]
+      },
+      treeOptions: {
+        bulkSelect: !!this.relationshipField,
+        draggable: true,
+        ghostUnpublished: true
+      },
+      moreMenu: [
+        {
+          label: 'New Page',
+          action: 'new'
+        }
+      ],
+      moreMenuButton: {
+        tooltip: {
+          content: 'More Options',
+          placement: 'bottom'
+        },
+        label: 'More Options',
+        icon: 'dots-vertical-icon',
+        iconOnly: true,
+        type: 'subtle',
+        modifiers: [ 'small', 'no-motion' ]
+      },
+      pageSetMenuSelection: 'live'
+    };
+  },
+  computed: {
+    moduleOptions() {
+      return apos.page;
+    },
+    items() {
+      if (!this.pages || !this.headers.length) {
+        return [];
+      }
+      return klona(this.pages);
+    },
+    selectAllChoice() {
+      const checkLen = this.checked.length;
+      const rowLen = this.pagesFlat.length;
+
+      return checkLen > 0 && checkLen !== rowLen ? {
+        value: 'checked',
+        indeterminate: true
+      } : {
+        value: 'checked'
+      };
+    },
+    saveRelationshipLabel() {
+      if (this.relationshipField && (this.relationshipField.max === 1)) {
+        return 'Select Page';
+      } else {
+        return 'Select Pages';
+      }
+    },
+    headers() {
+      let headers = this.options.columns || [];
+      if (!this.pageSetMenuSelectionIsLive) {
+        headers = headers.filter(h => h.component !== 'AposCellLabels');
+      }
+      return headers;
+    },
+    pageSetMenu() {
+      return [ {
+        label: 'apostrophe:live',
+        action: 'live',
+        modifiers: this.pageSetMenuSelectionIsLive ? [ 'selected', 'disabled' ] : []
+      }, {
+        label: 'apostrophe:archived',
+        action: 'archive',
+        modifiers: !this.pageSetMenuSelectionIsLive ? [ 'selected', 'disabled' ] : []
+      } ];
+    },
+    pageSetMenuButton() {
+      const button = {
+        label: this.pageSetMenuSelectionIsLive ? 'apostrophe:live' : 'apostrophe:archived',
+        icon: 'chevron-down-icon',
+        modifiers: [ 'no-motion', 'outline', 'icon-right' ],
+        class: 'apos-pages-manager__page-set-menu-button'
+      };
+      return button;
+    },
+    pageSetMenuSelectionIsLive() {
+      return this.pageSetMenuSelection === 'live';
+    }
+  },
+  watch: {
+    async pageSetMenuSelection() {
+      await this.getPages();
+    }
+  },
+  async mounted() {
+    // Get the data. This will be more complex in actuality.
+    this.modal.active = true;
+    await this.getPages();
+    this.modal.triggerFocusRefresh++;
+
+    apos.bus.$on('content-changed', this.getPages);
+    apos.bus.$on('command-menu-manager-create-new', this.create);
+    apos.bus.$on('command-menu-manager-close', this.confirmAndCancel);
+  },
+  destroyed() {
+    apos.bus.$off('content-changed', this.getPages);
+    apos.bus.$off('command-menu-manager-create-new', this.create);
+    apos.bus.$off('command-menu-manager-close', this.confirmAndCancel);
+  },
+  methods: {
+    moreMenuHandler(action) {
+      if (action === 'new') {
+        this.create();
+      }
+    },
+    async getPages () {
+      const self = this;
+      if (this.gettingPages) {
+        // Avoid race conditions by trying again later if already in progress
+        setTimeout(this.getPages, 100);
+        return;
+      }
+      // Not reactive, so not in data()
+      this.gettingPages = true;
+      try {
+        this.pages = [];
+        this.pagesFlat = [];
+
+        let pageTree = (await apos.http.get(
+          '/api/v1/@apostrophecms/page', {
+            busy: true,
+            qs: {
+              all: '1',
+              archived: this.relationshipField || this.pageSetMenuSelectionIsLive ? '0' : 'any',
+              // Also fetch published docs as _publishedDoc subproperties
+              withPublished: 1
+            },
+            draft: true
+          }
+        ));
+
+        // If editor is looking at the archive tree, trim the normal page tree response
+        if (this.pageSetMenuSelection === 'archive') {
+          pageTree = pageTree._children.find(page => page.slug === '/archive');
+          pageTree = pageTree._children;
+        }
+
+        formatPage(pageTree);
+
+        if (!pageTree.length && pageTree.length !== 0) {
+          pageTree = [ pageTree ];
+        }
+
+        this.pages = [ ...pageTree ];
+
+      } finally {
+        this.gettingPages = false;
+      }
+
+      function formatPage(page) {
+        if (page.length) {
+          page.forEach(formatPage);
+          return;
+        }
+
+        self.pagesFlat.push(klona(page));
+
+        if (Array.isArray(page._children)) {
+          page._children.forEach(formatPage);
+        }
+      }
+    },
+    async update(page) {
+      const body = {
+        _targetId: page.endContext,
+        _position: page.endIndex
+      };
+
+      const route = `${this.moduleOptions.action}/${page.changedId}`;
+      try {
+        await apos.http.patch(route, {
+          busy: true,
+          body,
+          draft: true
+        });
+      } catch (error) {
+        await apos.notify(error.body.message || this.$t('apostrophe:treeError'), {
+          type: 'danger',
+          icon: 'alert-circle-icon',
+          dismiss: true,
+          localize: false
+        });
+      }
+
+      await this.getPages();
+      if (this.pagesFlat.find(page => {
+        return (page.aposDocId === (window.apos.page.page && window.apos.page.page.aposDocId)) && page.archived;
+      })) {
+        // With the current page gone, we need to move to safe ground
+        location.assign(`${window.apos.prefix}/`);
+      }
+    },
+    toggleRowCheck(id) {
+      if (this.checked.includes(id)) {
+        this.checked = this.checked.filter(item => item !== id);
+      } else {
+        this.checked.push(id);
+      }
+    },
+    selectAll(event) {
+      if (!this.checked.length) {
+        this.pagesFlat.forEach((row) => {
+          this.toggleRowCheck(row._id);
+        });
+        return;
+      }
+
+      if (this.checked.length <= this.pagesFlat.length) {
+        this.checked.forEach((id) => {
+          this.toggleRowCheck(id);
+        });
+      }
+    },
+    async create() {
+      const doc = await apos.modal.execute(this.moduleOptions.components.editorModal, {
+        moduleName: this.moduleName
+      });
+      if (!doc) {
+        // Cancel clicked
+        return;
+      }
+      await this.getPages();
+      if (this.relationshipField) {
+        doc._fields = doc._fields || {};
+        // Must push to checked docs or it will try to do it for us
+        // and not include _fields
+        this.checkedDocs.push(doc);
+        this.checked.push(doc._id);
+      }
+    },
+    setCheckedDocs(checkedDocs) {
+      this.checked = checkedDocs.map(doc => doc._id);
+    },
+    updateCheckedDocs() {
+      this.checkedDocs = this.checked.map(_id => this.pagesFlat.find(page => page._id === _id));
+    }
+  }
+};

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

@@ -121,10 +121,16 @@ module.exports = {
           }, {
             permission: false
           });
-          if (published && doc.aposLastTargetId) {
-            return self.apos.page.move(req.clone({
-              mode: 'published'
-            }), published._id, doc.aposLastTargetId.replace(':draft', ':published'), doc.aposLastPosition);
+          if (published && (doc.level > 0)) {
+            const { lastTargetId, lastPosition } = await self.apos.page.inferLastTargetIdAndPosition(doc);
+            return self.apos.page.move(
+              req.clone({
+                mode: 'published'
+              }),
+              published._id,
+              lastTargetId.replace(':draft', ':published'),
+              lastPosition
+            );
           }
         }
       },
@@ -200,7 +206,13 @@ module.exports = {
             // chance we need to "replay" such a move
             return;
           }
-          await self.apos.page.move(publishedReq, result.published._id, result.published.aposLastTargetId, result.published.aposLastPosition);
+          const { lastTargetId, lastPosition } = await self.apos.page.inferLastTargetIdAndPosition(result.published);
+          await self.apos.page.move(
+            publishedReq,
+            result.published._id,
+            lastTargetId,
+            lastPosition
+          );
           const published = await self.apos.page.findOneForEditing(publishedReq, {
             _id: result.published._id
           });
@@ -322,27 +334,37 @@ module.exports = {
           ...options,
           setModified: false
         };
-        if (doc.aposLastTargetId) {
+        if (doc.level > 0) {
+          const { lastTargetId, lastPosition } = await self.apos.page.inferLastTargetIdAndPosition(doc);
           // Replay the high level positioning used to place it in the published locale
-          return self.apos.page.insert(_req, doc.aposLastTargetId.replace(':published', ':draft'), doc.aposLastPosition, draft, options);
-        } else if (!doc.level) {
+          return self.apos.page.insert(
+            _req,
+            lastTargetId.replace(':published', ':draft'),
+            lastPosition,
+            draft,
+            options
+          );
+        } else {
           // Insert the home page
           return self.apos.doc.insert(_req, draft, options);
-        } else {
-          throw new Error('Page inserted without using the page APIs, has no aposLastTargetId and aposLastPosition, cannot insert equivalent draft');
         }
       },
-      // Called for you when a page is inserted in
-      // the published locale, to ensure there is an equivalent
-      // draft page. You don't need to invoke this.
+      // Called for you when a page is published for the first time.
+      // You don't need to invoke this.
       async insertPublishedOf(req, doc, published, options = {}) {
         const _req = req.clone({
           mode: 'published'
         });
-        if (doc.aposLastTargetId) {
-          // Replay the high level positioning used to place it in the published locale
-          return self.apos.page.insert(_req, doc.aposLastTargetId.replace(':draft', ':published'), doc.aposLastPosition, published, options);
-        } else if (!doc.level) {
+        if (doc.level > 0) {
+          const { lastTargetId, lastPosition } = await self.apos.page.inferLastTargetIdAndPosition(doc);
+          // Replay the high level positioning used to place it in the draft locale
+          return self.apos.page.insert(
+            _req,
+            lastTargetId.replace(':draft', ':published'),
+            lastPosition,
+            published,
+            options);
+        } else {
           // Insert the home page
           Object.assign(published, {
             path: doc.path,
@@ -352,8 +374,6 @@ module.exports = {
             parkedId: doc.parkedId
           });
           return self.apos.doc.insert(_req, published, options);
-        } else {
-          throw new Error('insertPublishedOf called on a page that was never inserted via the standard page APIs, has no aposLastTargetId and aposLastPosition, cannot insert equivalent published page');
         }
       },
       // Update a page. The `options` argument may be omitted entirely.
@@ -399,13 +419,6 @@ module.exports = {
       },
       copyForPublication(_super, req, from, to) {
         _super(req, from, to);
-        const newMode = to.aposLocale.endsWith(':published') ? ':published' : ':draft';
-        const oldMode = (newMode === ':published') ? ':draft' : ':published';
-        // Home pages will not have this
-        if (from.aposLastTargetId) {
-          to.aposLastTargetId = from.aposLastTargetId.replace(oldMode, newMode);
-          to.aposLastPosition = from.aposLastPosition;
-        }
         to.parkedId = from.parkedId;
         to.parked = from.parked;
       },

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

@@ -232,7 +232,7 @@ module.exports = {
       getAll: [
         ...enableCacheOnDemand ? [ expressCacheOnDemand ] : [],
         async (req) => {
-          self.publicApiCheck(req);
+          await self.publicApiCheckAsync(req);
           const query = self.getRestQuery(req);
           if (!query.get('perPage')) {
             query.perPage(
@@ -272,7 +272,7 @@ module.exports = {
         ...enableCacheOnDemand ? [ expressCacheOnDemand ] : [],
         async (req, _id) => {
           _id = self.inferIdLocaleAndMode(req, _id);
-          self.publicApiCheck(req);
+          await self.publicApiCheckAsync(req);
           const doc = self.removeForbiddenFields(
             req,
             await self.getRestQuery(req).and({ _id }).toObject()
@@ -299,7 +299,7 @@ module.exports = {
         }
       ],
       async post(req) {
-        self.publicApiCheck(req);
+        await self.publicApiCheckAsync(req);
         if (req.body._newInstance) {
           const newInstance = self.newInstance();
           newInstance._previewable = self.addUrlsViaModule && (await self.addUrlsViaModule.readyToAddUrlsToPieces(req, self.name));
@@ -310,12 +310,12 @@ module.exports = {
       },
       async put(req, _id) {
         _id = self.inferIdLocaleAndMode(req, _id);
-        self.publicApiCheck(req);
+        await self.publicApiCheckAsync(req);
         return self.convertUpdateAndRefresh(req, req.body, _id);
       },
       async delete(req, _id) {
         _id = self.inferIdLocaleAndMode(req, _id);
-        self.publicApiCheck(req);
+        await self.publicApiCheckAsync(req);
         const piece = await self.findOneForEditing(req, {
           _id
         });
@@ -323,7 +323,7 @@ module.exports = {
       },
       async patch(req, _id) {
         _id = self.inferIdLocaleAndMode(req, _id);
-        self.publicApiCheck(req);
+        await self.publicApiCheckAsync(req);
         return self.convertPatchAndRefresh(req, req.body, _id);
       }
     };
@@ -614,7 +614,7 @@ module.exports = {
 
             // Return the operation group with the new operation added.
             return {
-              name: groupName,
+              action: groupName,
               ...groupProperties,
               operations: [
                 ...(acc[groupName] && acc[groupName].operations) || [],
@@ -1028,10 +1028,13 @@ module.exports = {
         piece.title = 'Generated #' + (i + 1);
         return piece;
       },
-      getRestQuery(req) {
+      // Can be extended on a project level with `_super(req, true)` to disable
+      // permission check and public API projection. You shouldn't do this
+      // if you're not sure what you're doing.
+      getRestQuery(req, omitPermissionCheck = false) {
         const query = self.find(req).attachments(true);
         query.applyBuildersSafely(req.query);
-        if (!self.canAccessApi(req)) {
+        if (!omitPermissionCheck && !self.canAccessApi(req)) {
           if (!self.options.publicApiProjection) {
             // Shouldn't be needed thanks to publicApiCheck, but be sure
             query.and({
@@ -1058,6 +1061,11 @@ module.exports = {
           }
         }
       },
+      // An async version of the above. It can be overridden to implement
+      // an asynchronous check of the public API permissions.
+      async publicApiCheckAsync(req) {
+        return self.publicApiCheck(req);
+      },
       // If the piece does not yet have a slug, add one based on the
       // title; throw an error if there is no title
       ensureSlug(piece) {
@@ -1164,8 +1172,8 @@ module.exports = {
 
         return browserOptions;
       },
-      find(_super, req, criteria, projection) {
-        return _super(req, criteria, projection).defaultSort(self.options.sort || { updatedAt: -1 });
+      find(_super, req, criteria, options) {
+        return _super(req, criteria, options).defaultSort(self.options.sort || { updatedAt: -1 });
       },
       newInstance(_super) {
         if (!self.options.singletonAuto) {

package/modules/@apostrophecms/piece-type/ui/apos/components/AposDocsManager.vue

@@ -72,6 +72,7 @@
             :is-relationship="!!relationshipField"
             :checked-count="checked.length"
             :batch-operations="moduleOptions.batchOperations"
+            :module-name="moduleName"
             @select-click="selectAll"
             @search="onSearch"
             @page-change="updatePage"