apostrophe 3.41.1 → 3.43.0

package/CHANGELOG.md

@@ -1,5 +1,63 @@
 # Changelog
 
+## 3.43.0 (2023-03-29)
+
+### Adds
+
+* Add the possibility to override the default "Add Item" button label by setting the `itemLabel` option of an `array` field.
+* Adds `touch` task for every piece type. This task invokes `update` on each piece, which will execute all of the same event handlers that normally execute when a piece of that type is updated. Example usage: `node app article:touch`.
+
+### Fixes
+
+* Hide the suggestion help from the relationship input list when the user starts typing a search term.
+* Hide the suggestion hint from the relationship input list when the user starts typing a search term except when there are no matches to display.
+* Disable context menu for related items when their `relationship` field has no sub-[`fields`](https://v3.docs.apostrophecms.org/guide/relationships.html#providing-context-with-fields) configured.
+
+## 3.42.0 (2023-03-16)
+
+### Adds
+
+* You can now set `style: table` on inline arrays. It will display the array as a regular HTML table instead of an accordion.
+See the [array field documentation](https://v3.docs.apostrophecms.org/reference/field-types/array.html#settings) for more information.
+* You can now set `draggable: false` on inline arrays. It will disable the drag and drop feature. Useful when the order is not significant.
+See the [array field documentation](https://v3.docs.apostrophecms.org/reference/field-types/array.html#settings) for more information.
+* You can now set the label and icon to display on inline arrays when they are empty.
+See the [array field documentation](https://v3.docs.apostrophecms.org/reference/field-types/array.html#whenEmpty) for more information.
+* We have added a new and improved suggestion UI to relationship fields.
+* The `utilityOperations` feature of piece types now supports additional properties:
+`relationship: true` (show the operation only when editing a relationship), `relationship: false` (never show
+the operation when editing a relationship), `button: true`, `icon` and `iconOnly: true`.
+When `button: true` is specified, the operation appears as a standalone button rather than
+being tucked away in the "more" menu.
+* In addition, `utilityOperations` can now specify `eventOptions` with an `event` subproperty
+instead of `modalOptions`. This is useful with the new `edit` event (see below).
+* Those extending our admin UI on the front end can now open a modal to create or edit a page or piece by calling
+`await apos.doc.edit({ type: 'article' })` (the type here is an example). To edit an existing document add an
+`_id` property. To copy an existing document (like our "duplicate" feature) add a `copyOf`
+property. When creating new pages, `type` can be sent to `@apostrophecms/page` for convenience
+(note that the `type` property does not override the default or current page type in the editor).
+* The `edit` Apostrophe event is now available and takes an object with the same properties
+as above. This is useful when configuring `utilityOperations`.
+* The `content-changed` Apostrophe event can now be emitted with a `select: true` property. If a
+document manager for the relevant content type is open, it will attempt to add the document to the
+current selection. Currently this works best with newly inserted documents.
+* Localized strings in the admin UI can now use `$t(key)` to localize a string inside
+an interpolated variable. This was accomplished by setting `skipOnVariables` to false
+for i18next, solely on the front end for admin UI purposes.
+* The syntax of the method defined for dynamic `choices` now accepts a module prefix to get the method from, and the `()` suffix.
+This has been done for consistency with the external conditions syntax shipped in the previous release. See the documentation for more information.
+* Added the `viewPermission` property of schema fields, and renamed `permission` to `editPermission` (with backwards
+compatibility) for clarity. You can now decide if a schema field requires permissions to be visible or editable.
+See the documentation for more information.
+* Display the right environment label on login page. By default, based on `NODE_ENV`, overriden by `environmentLabel` option in `@apostrophecms/login` module. The environment variable `APOS_ENV_LABEL` will override this. Note that `NODE_ENV` should generally only be set to `development` (the default) or `production` as many Node.js modules opt into optimizations suitable for all deployed environments when it is set to `production`. This is why we offer the separate `APOS_ENV_LABEL` variable.
+
+### Fixes
+
+* Do not log unnecessary "required" errors for hidden fields.
+* Fixed a bug that prevented "Text Align" from working properly in the rich text editor in certain cases.
+* Fix typo in `@apostrophecms/doc-type` and `@apostrophecms/submitted-drafts` where we were using `canCreate` instead of `showCreate` to display the `Create New` button or showing the `Copy` button in `Manager` modals.
+* Send external condition results in an object so that numbers are supported as returned values.
+
 ## 3.41.1 (2023-03-07)
 
 No changes. Publishing to make sure 3.x is tagged `latest` in npm, rather than 2.x.
@@ -8,8 +66,8 @@ No changes. Publishing to make sure 3.x is tagged `latest` in npm, rather than 2
 
 ### Adds
 
-* Handle external conditions to display fields according to the result of a module method, or multiple methods from different modules.  
-This can be useful for displaying fields according to the result of an external API or any business logic run on the server.
+* Handle external conditions to display fields according to the result of a module method, or multiple methods from different modules.
+This can be useful for displaying fields according to the result of an external API or any business logic run on the server. See the documentation for more information.
 
 ### Fixes
 

package/modules/@apostrophecms/admin-bar/index.js

@@ -338,6 +338,7 @@ module.exports = {
             submitted: context.submitted,
             lastPublishedAt: context.lastPublishedAt,
             _edit: context._edit,
+            _publish: context._publish,
             aposMode: context.aposMode,
             aposLocale: context.aposLocale,
             aposDocId: context.aposDocId

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

@@ -98,7 +98,7 @@ export default {
       return !!this.patchesSinceSave.length;
     },
     canPublish() {
-      return apos.modules[this.context.type].canPublish;
+      return this.context._publish || apos.modules[this.context.type].canPublish;
     },
     readyToPublish() {
       if (this.canPublish) {

package/modules/@apostrophecms/asset/lib/globalIcons.js

@@ -15,6 +15,7 @@ module.exports = {
   'arrow-left-icon': 'ArrowLeft',
   'arrow-right-icon': 'ArrowRight',
   'arrow-up-icon': 'ArrowUp',
+  'binoculars-icon': 'Binoculars',
   'calendar-icon': 'Calendar',
   'check-all-icon': 'CheckAll',
   'check-bold-icon': 'CheckBold',
@@ -101,6 +102,8 @@ module.exports = {
   'redo-icon': 'RedoVariant',
   'refresh-icon': 'Refresh',
   'sign-text-icon': 'SignText',
+  'tag-icon': 'Tag',
+  'text-box-icon': 'TextBox',
   'text-box-remove-icon': 'TextBoxRemove',
   'trash-can-icon': 'TrashCan',
   'trash-can-outline-icon': 'TrashCanOutline',

package/modules/@apostrophecms/doc/ui/apos/apps/AposDoc.js

@@ -0,0 +1,42 @@
+// High-level conveniences for working with documents in Apostrophe
+// on the front end, so that developers need only know the document
+// type they want and do not have to look up modal names in module
+// configuration etc.
+
+export default () => {
+  // Create or edit a document. `type` must be the document type, or
+  // `@apostrophecms/page`.
+  //
+  // `_id` should be the `_id` of the existing document to edit; leave
+  // blank to create a new document.
+  //
+  // `copyOf` is an optional, existing document from which properties should be copied.
+  //
+  // On success, returns the new or updated document. If the modal is cancelled,
+  // `undefined` is returned. Be sure to `await` the result.
+  apos.doc.edit = async ({
+    type,
+    _id,
+    copyOf
+  }) => {
+    if (!type) {
+      throw new Error('You must specify the type of document to edit.');
+    }
+    if (apos.page.validPageTypes.includes(type)) {
+      type = '@apostrophecms/page';
+    }
+    const modal = apos.modules[type]?.components?.editorModal;
+    if (!modal) {
+      throw new Error(`${type} is not a valid piece or page type, or cannot be edited`);
+    }
+    return apos.modal.execute(modal, {
+      moduleName: type,
+      docId: _id,
+      copyOf
+    });
+  };
+  // If you don't care about the returned value, you can emit an
+  // 'edit' apostrophe event with the same object you would pass to
+  // apos.doc.edit().
+  apos.bus.$on('edit', apos.doc.edit);
+};

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

@@ -10,7 +10,13 @@ module.exports = {
     publishRole: 'editor',
     viewRole: false,
     previewDraft: true,
-    relatedDocType: null
+    relatedDocType: null,
+    relationshipSuggestionLabel: 'apostrophe:relationshipSuggestionLabel',
+    relationshipSuggestionHelp: 'apostrophe:relationshipSuggestionHelp',
+    relationshipSuggestionLimit: 25,
+    relationshipSuggestionSort: { updatedAt: -1 },
+    relationshipSuggestionIcon: 'text-box-icon',
+    relationshipSuggestionFields: [ 'slug' ]
   },
   cascades: [ 'fields' ],
   fields(self) {
@@ -77,7 +83,7 @@ module.exports = {
       self.__meta.name === '@apostrophecms/global' ||
       self.apos.instanceOf(self, '@apostrophecms/any-page-type') ||
       self.apos.instanceOf(self, '@apostrophecms/page-type') ||
-      self.options.canCreate === false ||
+      self.options.showCreate === false ||
       self.options.showPermissions === false
     ) {
       return null;
@@ -212,54 +218,12 @@ module.exports = {
   handlers(self) {
     return {
       beforeSave: {
-        async updateCacheField(req, doc) {
-          const relatedDocsIds = self.getRelatedDocsIds(req, doc);
-
-          // - Remove current doc reference from docs that include it
-          // - Update these docs' cache field
-          await self.apos.doc.db.updateMany({
-            relatedReverseIds: { $in: [ doc.aposDocId ] },
-            aposLocale: { $in: [ doc.aposLocale, null ] }
-          }, {
-            $pull: { relatedReverseIds: doc.aposDocId },
-            $set: { cacheInvalidatedAt: doc.updatedAt }
-          });
-
-          if (relatedDocsIds.length) {
-            // - Add current doc reference to related docs
-            // - Update related docs' cache field
-            await self.apos.doc.db.updateMany({
-              aposDocId: { $in: relatedDocsIds },
-              aposLocale: { $in: [ doc.aposLocale, null ] }
-            }, {
-              $push: { relatedReverseIds: doc.aposDocId },
-              $set: { cacheInvalidatedAt: doc.updatedAt }
-            });
-          }
-
-          if (doc.relatedReverseIds && doc.relatedReverseIds.length) {
-            // Update related reverse docs' cache field
-            await self.apos.doc.db.updateMany({
-              aposDocId: { $in: doc.relatedReverseIds },
-              aposLocale: { $in: [ doc.aposLocale, null ] }
-            }, {
-              $set: { cacheInvalidatedAt: doc.updatedAt }
-            });
-          }
-
-          if (doc._parentSlug) {
-            // Update piece index page's cache field
-            await self.apos.doc.db.updateOne({
-              slug: doc._parentSlug,
-              aposLocale: { $in: [ doc.aposLocale, null ] }
-            }, {
-              $set: { cacheInvalidatedAt: doc.updatedAt }
-            });
-          }
-        },
         prepareForStorage(req, doc) {
           self.apos.schema.prepareForStorage(req, doc);
         },
+        async updateCacheField(req, doc) {
+          await self.updateCacheField(req, doc);
+        },
         slugPrefix(req, doc) {
           const prefix = self.options.slugPrefix;
           if (prefix) {
@@ -398,6 +362,51 @@ module.exports = {
 
   methods(self) {
     return {
+      async updateCacheField(req, doc) {
+        const relatedDocsIds = self.getRelatedDocsIds(req, doc);
+
+        // - Remove current doc reference from docs that include it
+        // - Update these docs' cache field
+        await self.apos.doc.db.updateMany({
+          relatedReverseIds: { $in: [ doc.aposDocId ] },
+          aposLocale: { $in: [ doc.aposLocale, null ] }
+        }, {
+          $pull: { relatedReverseIds: doc.aposDocId },
+          $set: { cacheInvalidatedAt: doc.updatedAt }
+        });
+
+        if (relatedDocsIds.length) {
+          // - Add current doc reference to related docs
+          // - Update related docs' cache field
+          await self.apos.doc.db.updateMany({
+            aposDocId: { $in: relatedDocsIds },
+            aposLocale: { $in: [ doc.aposLocale, null ] }
+          }, {
+            $push: { relatedReverseIds: doc.aposDocId },
+            $set: { cacheInvalidatedAt: doc.updatedAt }
+          });
+        }
+
+        if (doc.relatedReverseIds && doc.relatedReverseIds.length) {
+          // Update related reverse docs' cache field
+          await self.apos.doc.db.updateMany({
+            aposDocId: { $in: doc.relatedReverseIds },
+            aposLocale: { $in: [ doc.aposLocale, null ] }
+          }, {
+            $set: { cacheInvalidatedAt: doc.updatedAt }
+          });
+        }
+
+        if (doc._parentSlug) {
+          // Update piece index page's cache field
+          await self.apos.doc.db.updateOne({
+            slug: doc._parentSlug,
+            aposLocale: { $in: [ doc.aposLocale, null ] }
+          }, {
+            $set: { cacheInvalidatedAt: doc.updatedAt }
+          });
+        }
+      },
       addContextMenu() {
         self.apos.doc.addContextOperation(self.__meta.name, {
           action: 'shareDraft',
@@ -412,7 +421,7 @@ module.exports = {
         const relatedDocsIds = [];
         const handlers = {
           relationship: (field, doc) => {
-            relatedDocsIds.push(...doc[field.name].map(relatedDoc => self.apos.doc.toAposDocId(relatedDoc)));
+            relatedDocsIds.push(...(doc[field.idsStorage] || []));
           }
         };
 
@@ -522,13 +531,16 @@ module.exports = {
         change.text = doc.title;
       },
       // Return a new schema containing only fields for which the
-      // current user has the permission specified by the `permission`
-      // property of the schema field, or there is no `permission` property for the field.
+      // current user has the permission specified by the `editPermission`
+      // property of the schema field, or there is no `editPermission`|`viewPermission` property for the field.
       allowedSchema(req) {
         let disabled;
         let type;
         const schema = _.filter(self.schema, function (field) {
-          return !field.permission || self.apos.permission.can(req, field.permission && field.permission.action, field.permission && field.permission.type);
+          return (!field.editPermission && !field.viewPermission) ||
+            (field.editPermission && self.apos.permission.can(req, field.editPermission.action, field.editPermission.type)) ||
+            (field.viewPermission && self.apos.permission.can(req, field.viewPermission.action, field.viewPermission.type)) ||
+            false;
         });
         const typeIndex = _.findIndex(schema, { name: 'type' });
         if (typeIndex !== -1) {
@@ -1375,6 +1387,25 @@ module.exports = {
         });
 
         return draft;
+      },
+
+      // Remove forbidden fields from document
+      // A forbidden field is a field for which the current user does not have the appropriate viewPermission to see it
+      removeForbiddenFields(req, doc) {
+        if (!doc) {
+          return doc;
+        }
+
+        const forbiddenSchemaFields = Object.values(self.schema)
+          .filter(field => {
+            return field.viewPermission && !self.apos.permission.can(req, field.viewPermission.action, field.viewPermission.type);
+          });
+
+        forbiddenSchemaFields.forEach(field => {
+          delete doc[field.name];
+        });
+
+        return doc;
       }
     };
   },

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

@@ -174,6 +174,13 @@ export default {
     followingUtils() {
       return this.followingValues('utility');
     },
+    canPublish() {
+      if (this.original && this.original._id) {
+        return this.original._publish;
+      }
+
+      return this.moduleOptions.canPublish;
+    },
     saveDisabled() {
       if (this.restoreOnly) {
         // Can always restore if it's a read-only view of the archive
@@ -197,7 +204,7 @@ export default {
       if (!this.manuallyPublished) {
         return true;
       }
-      if (this.moduleOptions.canPublish) {
+      if (this.canPublish) {
         // Primary button is "publish". If it is previously published and the
         // draft is not modified since then, don't allow it
         return this.published && !this.isModifiedFromPublished;
@@ -261,7 +268,7 @@ export default {
       if (this.restoreOnly) {
         return 'apostrophe:restore';
       } else if (this.manuallyPublished) {
-        if (this.moduleOptions.canPublish) {
+        if (this.canPublish) {
           if (this.copyOf) {
             return 'apostrophe:publish';
           } else if (this.original && this.original.lastPublishedAt) {
@@ -468,7 +475,7 @@ export default {
       await this.loadDoc();
     },
     async onSave(navigate = false) {
-      if (this.moduleOptions.canPublish || !this.manuallyPublished) {
+      if (this.canPublish || !this.manuallyPublished) {
         await this.save({
           andPublish: this.manuallyPublished,
           navigate

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

@@ -23,7 +23,8 @@ module.exports = {
     showPermissions: true,
     // Files should by default be considered "related documents" when localizing
     // another document that references them
-    relatedDocument: true
+    relatedDocument: true,
+    relationshipSuggestionIcon: 'file-document-icon'
   },
   fields: {
     remove: [ 'visibility' ],

package/modules/@apostrophecms/file-tag/index.js

@@ -7,7 +7,8 @@ module.exports = {
     autopublish: true,
     editRole: 'editor',
     publishRole: 'editor',
-    shortcut: 'G,g'
+    shortcut: 'G,g',
+    relationshipSuggestionIcon: 'tag-icon'
   },
   fields: {
     remove: [ 'visibility' ]