apostrophe 3.43.0 → 3.45.0

package/CHANGELOG.md

@@ -1,5 +1,61 @@
 # Changelog
 
+## 3.45.0 (2023-04-27)
+
+### Adds
+
+* Rich text widgets now support the `insert` option, an array
+which currently may contain the strings `image` and `table` in order to add a
+convenient "insert menu" that pops up when the slash key is pressed.
+This provides a better user experience for rich text features that shouldn't
+require that the user select existing text before using them.
+* Auto expand inline array width if needed using `width: max-content` in the admin UI.
+* The "browse" button is now available when selecting pages and pieces
+to link to in the rich text editor.
+* The "browse" button is also available when selecting inline images
+in the rich text editor.
+* Images are now previewed in the relationship field's compact list view.
+* The new `apos-refreshing` Apostrophe bus event can be used to prevent
+Apostrophe from refreshing the main content zone of the page when images
+and pieces are edited, by clearing the `refresh` property of the object
+passed to the event.
+* To facilitate custom click handlers, an `apos.modal.onTopOf(el1, el2)` function is now
+available to check whether an element is considered to be "on top of" another element in
+the modal stack.
+
+### Changes
+
+* The `v-click-outside-element` Vue directive now understands that modals "on top of"
+an element should be considered to be "inside" the element, e.g. clicks on them
+shouldn't close the link dialog etc.
+
+### Fixes
+
+* Rich text widgets save more reliably when many actions are taken quickly just before save.
+
+## 3.44.0 (2023-04-13)
+
+### Adds
+
+* `checkboxes` fields now support a new `style: 'combobox'` option for a better multiple-select experience when there
+are many choices.
+* If the new `guestApiAccess` option is set to `true` for a piece type or for `@apostrophecms/page`,
+Apostrophe will allow all logged-in users to access the GET-method REST APIs of that
+module, not just users with editing privileges, even if `publicApiProjection` is not set.
+This is useful when the goal is to allow REST API access to "guest" users who have
+project-specific reasons to fetch access content via REST APIs.
+* `test-lib/utils.js` has new `createUser` and `loginAs` methods for the convenience of
+those writing mocha tests of Apostrophe modules.
+* `batchOperations` permissions: if a `permission` property is added to any entry in the `batchOperations` cascade of a piece-type module, this permission will be checked for every user. See `batchOperations` configuration in `modules/@apostrophecms/piece-type/index.js`. The check function `checkBatchOperationsPermissions` can be extended. Please note that this permission is checked only to determine whether to offer the operation.
+
+### Fixes
+* Fix child page slug when title is deleted
+
+### Fixes
+
+* Fix various issues on conditional fields that were occurring when adding new widgets with default values or selecting a falsy value in a field that has a conditional field relying on it.  
+Populate new or existing doc instances with default values and add an empty `null` choice to select fields that do not have a default value (required or not) and to the ones configured with dynamic choices.
+
 ## 3.43.0 (2023-03-29)
 
 ### Adds

package/force-deploy

@@ -0,0 +1 @@
+4

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

@@ -79,10 +79,11 @@ export default {
   },
   computed: {
     contextBarActive() {
-      return window.apos.adminBar.contextBar && this.canEdit;
+      return window.apos.adminBar.contextBar && (this.canEdit || this.moduleOptions.canLocalize);
     },
     canEdit() {
-      return this.context._edit || ((this.context.aposLocale && this.context.aposLocale.endsWith(':published')) && this.draftIsEditable);
+      return this.context._edit || ((this.context.aposLocale && this.context.aposLocale.endsWith(':published')) &&
+        this.draftIsEditable);
     },
     classes() {
       if (!this.contextBarActive) {
@@ -468,7 +469,6 @@ export default {
       }
     },
     async onContentChanged(e) {
-
       if (
         (e.doc && (e.doc._id === this.context._id)) ||
         (e.docIds && e.docIds.includes(this.context._id))
@@ -484,9 +484,15 @@ export default {
           });
         }
       }
-      await this.refresh({
-        scrollcheck: e.action === 'history'
-      });
+      const refreshOptions = {
+        refresh: true
+      };
+      apos.bus.$emit('apos-refreshing', refreshOptions);
+      if (refreshOptions.refresh) {
+        await this.refresh({
+          scrollcheck: e.action === 'history'
+        });
+      }
     },
     async switchEditMode(editing) {
       this.editMode = editing;

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

@@ -763,6 +763,11 @@ module.exports = {
       async findOneForCopying(req, criteria) {
         return self.findOneForEditing(req, criteria);
       },
+      // Identical to findOneForEditing by default, but could be
+      // overridden usefully in subclasses.
+      async findOneForLocalizing(req, criteria) {
+        return self.findOneForEditing(req, criteria);
+      },
       // Submit the current draft for review. The identity
       // of `req.user` is associated with the submission.
       // Returns the `submitted` object, with `by`, `byId`,
@@ -1424,8 +1429,13 @@ module.exports = {
           label,
           pluralLabel,
           relatedDocument: self.options.relatedDocument,
+          canEdit: self.apos.permission.can(req, 'edit', self.name, 'draft'),
           canPublish: self.apos.permission.can(req, 'publish', self.name)
         };
+        browserOptions.canLocalize = browserOptions.canEdit &&
+          self.options.localized &&
+          Object.keys(self.apos.i18n.locales).length > 1 &&
+          Object.values(self.apos.i18n.locales).some(locale => locale._edit);
         browserOptions.action = self.action;
         browserOptions.schema = self.allowedSchema(req);
         browserOptions.localized = self.isLocalized();

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

@@ -181,6 +181,10 @@ export default {
       return menu;
     },
     customMenusByContext() {
+      if (!this.canEdit) {
+        return [];
+      }
+
       const menus = this.customOperationsByContext
         .map(op => ({
           label: op.label,
@@ -233,7 +237,7 @@ export default {
       }
     },
     canDismissSubmission() {
-      return this.context.submitted && (this.canPublish || (this.context.submitted.byId === apos.login.user._id));
+      return this.canEdit && this.context.submitted && (this.canPublish || (this.context.submitted.byId === apos.login.user._id));
     },
     canDiscardDraft() {
       if (!this.manuallyPublished) {
@@ -242,6 +246,9 @@ export default {
       if (!this.context._id) {
         return false;
       }
+      if (!this.canEdit) {
+        return false;
+      }
       return (
         (!this.context.lastPublishedAt) &&
         !this.moduleOptions.singleton
@@ -251,10 +258,12 @@ export default {
       );
     },
     canLocalize() {
-      return (Object.keys(apos.i18n.locales).length > 1) && this.moduleOptions.localized && this.context._id;
+      return this.moduleOptions.canLocalize &&
+        this.context._id;
     },
     canArchive() {
       return (
+        this.canEdit &&
         this.context._id &&
         !this.moduleOptions.singleton &&
         !this.context.archived &&
@@ -264,6 +273,7 @@ export default {
     },
     canUnpublish() {
       return (
+        this.canEdit &&
         !this.context.parked &&
         this.moduleOptions.canPublish &&
         this.context.lastPublishedAt &&
@@ -271,10 +281,14 @@ export default {
       );
     },
     canCopy() {
-      return this.canEdit && !this.moduleOptions.singleton && this.context._id;
+      return this.canEdit &&
+        this.moduleOptions.canEdit &&
+        !this.moduleOptions.singleton &&
+        this.context._id;
     },
     canRestore() {
       return (
+        this.canEdit &&
         this.context._id &&
         this.context.archived &&
         ((this.moduleOptions.canPublish && this.context.lastPublishedAt) || !this.manuallyPublished)

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

@@ -162,6 +162,7 @@ export default {
         ref: null
       },
       published: null,
+      readOnly: false,
       restoreOnly: false,
       saveMenu: null,
       generation: 0
@@ -174,14 +175,24 @@ export default {
     followingUtils() {
       return this.followingValues('utility');
     },
+    canEdit() {
+      if (this.original && this.original._id) {
+        return this.original._edit || this.moduleOptions.canEdit;
+      }
+
+      return this.moduleOptions.canEdit;
+    },
     canPublish() {
       if (this.original && this.original._id) {
-        return this.original._publish;
+        return this.original._publish || this.moduleOptions.canPublish;
       }
 
       return this.moduleOptions.canPublish;
     },
     saveDisabled() {
+      if (!this.canEdit) {
+        return true;
+      }
       if (this.restoreOnly) {
         // Can always restore if it's a read-only view of the archive
         return false;
@@ -421,10 +432,6 @@ export default {
     async loadDoc() {
       let docData;
       try {
-        if (!await this.lock(this.getOnePath, this.docId)) {
-          await this.lockNotAvailable();
-          return;
-        }
         docData = await apos.http.get(this.getOnePath, {
           busy: true,
           qs: {
@@ -438,6 +445,12 @@ export default {
         } else {
           this.restoreOnly = false;
         }
+        const canEdit = docData._edit || this.moduleOptions.canEdit;
+        this.readOnly = canEdit === false;
+        if (canEdit && !await this.lock(this.getOnePath, this.docId)) {
+          await this.lockNotAvailable();
+          return;
+        }
       } catch {
         await apos.notify('apostrophe:loadDocFailed', {
           type: 'warning',
@@ -451,7 +464,10 @@ export default {
             this.docType = docData.type;
           }
           this.original = klona(docData);
-          this.docFields.data = docData;
+          this.docFields.data = {
+            ...this.getDefault(),
+            ...docData
+          };
           if (this.published) {
             this.changed = detectDocChange(this.schema, this.original, this.published, { differences: true });
           }
@@ -460,6 +476,21 @@ export default {
         }
       }
     },
+    getDefault() {
+      const doc = {};
+      this.schema.forEach(field => {
+        if (field.name.startsWith('_')) {
+          return;
+        }
+        // Using `hasOwn` here, not simply checking if `field.def` is truthy
+        // so that `false`, `null`, `''` or `0` are taken into account:
+        const hasDefaultValue = Object.hasOwn(field, 'def');
+        doc[field.name] = hasDefaultValue
+          ? klona(field.def)
+          : null;
+      });
+      return doc;
+    },
     async preview() {
       if (!await this.confirmAndCancel()) {
         return;

package/modules/@apostrophecms/i18n/i18n/de.json

@@ -4,6 +4,7 @@
   "addWidgetType": "{{ label }} hinzufügen",
   "admin": "Administrator",
   "affirmativeLabel": "Ja, fortsetzen.",
+  "allSelected": "Alle ausgewählt",
   "altText": "Alternativtext",
   "altTextHelp": "Bildbeschreibung oder alternativer Text, der für Bildschirmleser verwendet wird.",
   "any": "Irgendwas",

package/modules/@apostrophecms/i18n/i18n/en.json

@@ -9,6 +9,7 @@
   "addWidgetType": "Add {{ label }}",
   "admin": "Admin",
   "affirmativeLabel": "Yes, continue.",
+  "allSelected": "All Selected",
   "altText": "Alt Text",
   "altTextHelp": "Image description used for accessibility",
   "anchorId": "Anchor ID",
@@ -192,6 +193,7 @@
   "hideInNavigation": "Hide in Navigation",
   "home": "Home",
   "image": "Image",
+  "imageDescription": "Add an inline image",
   "imageFile": "Image File",
   "imagePlaceholder": "Image placeholder",
   "imageTag": "Image Tag",
@@ -374,11 +376,13 @@
   "richTextH4": "Heading 4 (H4)",
   "richTextHighlight": "Mark",
   "richTextHorizontalRule": "Horizontal Rule",
+  "richTextInsertMenuHeading": "Insert...",
   "richTextItalic": "Italic",
   "richTextLink": "Link",
   "richTextOrderedList": "Ordered List",
   "richTextParagraph": "Paragraph (P)",
   "richTextPlaceholder": "Start Typing Here...",
+  "richTextPlaceholderWithInsertMenu": "Start Typing Here or Press /...",
   "richTextRedo": "Redo",
   "richTextStrikethrough": "Strike",
   "richTextStyleConfigWarning": "Misconfigured rich text style: label: {{ label }}, {{ tag }}",
@@ -437,6 +441,7 @@
   "superscript": "Superscript",
   "switchLocalesAndLocalizePage": "Switch locales and localize page to {{ label }}?",
   "table": "Table",
+  "tableDescription": "Add tabular content to your page",
   "tagYourImages": "Tag your images to make searching and filtering the media manager easier",
   "tags": "Tags",
   "takeActionAndCreateNew": "{{ saveLabel }} and Create New",

package/modules/@apostrophecms/i18n/i18n/es.json

@@ -3,6 +3,7 @@
   "addItem": "Añadir Elemento",
   "addWidgetType": "Añadir {{ label }}",
   "admin": "Administrador",
+  "allSelected": "Todo seleccionado",
   "altText": "Texto Alternativo",
   "altTextHelp": "Descripción de imagen utilizada para accesibilidad",
   "any": "Cualquiera",

package/modules/@apostrophecms/i18n/i18n/fr.json

@@ -3,6 +3,7 @@
   "addItem": "Ajouter un élément",
   "addWidgetType": "Ajouter {{ label }}",
   "affirmativeLabel": "Oui, continuer.",
+  "allSelected": "Tout Selectionné",
   "altText": "Texte alternatif",
   "altTextHelp": "Description d'image utilisée pour l'accessibilité",
   "any": "Quelconque",

package/modules/@apostrophecms/i18n/i18n/pt-BR.json

@@ -3,6 +3,7 @@
   "addItem": "Adicionar Item",
   "addWidgetType": "Adicionar {{ label }}",
   "admin": "Admin",
+  "allSelected": "Tudo Selecionado",
   "altText": "Texto Alternativo",
   "altTextHelp": "Descrição da imagem usada para acessibilidade",
   "any": "Qualquer",

package/modules/@apostrophecms/i18n/i18n/sk.json

@@ -4,6 +4,7 @@
   "addWidgetType": "Pridať {{ label }}",
   "admin": "Admin",
   "affirmativeLabel": "Áno, pokračovať.",
+  "allSelected": "Všetky Vybrané",
   "altText": "Alternatívny text",
   "altTextHelp": "Alternatívny popis obrázkov pre zlepšenú prístupnosť",
   "any": "ľubovoľný",

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

@@ -584,6 +584,9 @@ module.exports = {
             label: 'English'
           }
         };
+        for (const locale in locales) {
+          locales[locale]._edit = true;
+        }
         verifyLocales(locales, self.apos.options.baseUrl);
         return locales;
       },

package/modules/@apostrophecms/i18n/ui/apos/components/AposI18nLocalize.vue

@@ -278,7 +278,8 @@ export default {
         ([ locale, options ]) => {
           return {
             name: locale,
-            label: options.label || locale
+            label: options.label || locale,
+            _edit: options._edit
           };
         }
       ),
@@ -382,12 +383,12 @@ export default {
         : apos.modules[this.doc.type].action;
     },
     filteredLocales() {
-      return this.locales.filter(({ name, label }) => {
-        const matches = term =>
-          term
-            .toLowerCase()
-            .includes(this.wizard.sections.selectLocales.filter.toLowerCase());
+      const matches = term =>
+        term
+          .toLowerCase()
+          .includes(this.wizard.sections.selectLocales.filter.toLowerCase());
 
+      return this.locales.filter(({ name, label }) => {
         return matches(name) || matches(label);
       });
     },
@@ -395,7 +396,7 @@ export default {
       return this.wizard.values.toLocales.data;
     },
     allSelected() {
-      return this.selectedLocales.length === this.locales.filter(locale => !this.isCurrentLocale(locale)).length;
+      return this.selectedLocales.length === this.locales.filter(locale => !this.isCurrentLocale(locale) && this.canEditLocale(locale)).length;
     },
     relatedDocTypes() {
       const types = {};
@@ -532,6 +533,9 @@ export default {
     isCurrentLocale(locale) {
       return window.apos.i18n.locale === locale.name;
     },
+    canEditLocale(locale) {
+      return !!locale._edit;
+    },
     isSelected(locale) {
       return this.wizard.values.toLocales.data.some(
         ({ name }) => name === locale.name
@@ -541,13 +545,13 @@ export default {
       return !!this.localized[locale.name];
     },
     selectAll() {
-      this.wizard.values.toLocales.data = this.locales.filter(locale => !this.isCurrentLocale(locale));
+      this.wizard.values.toLocales.data = this.locales.filter(locale => !this.isCurrentLocale(locale) && this.canEditLocale(locale));
     },
     deselectAll() {
       this.wizard.values.toLocales.data = [];
     },
     toggleLocale(locale) {
-      if (!this.isSelected(locale) && !this.isCurrentLocale(locale)) {
+      if (!this.isSelected(locale) && !this.isCurrentLocale(locale) && this.canEditLocale(locale)) {
         this.wizard.values.toLocales.data.push(locale);
       } else if (this.isSelected(locale)) {
         this.wizard.values.toLocales.data = this.wizard.values.toLocales.data.filter(l => l !== locale);
@@ -590,6 +594,9 @@ export default {
       if (this.isCurrentLocale(locale)) {
         classes['apos-current-locale'] = true;
       }
+      if (!this.canEditLocale(locale)) {
+        classes['apos-disabled-locale'] = true;
+      }
       return classes;
     },
     // Singular type name for label (returns an i18next key)
@@ -948,15 +955,18 @@ export default {
   line-height: 1;
   border-radius: var(--a-border-radius);
 
-  &:not(.apos-current-locale) {
+  &:not(.apos-current-locale),
+  &:not(.apos-disabled-locale) {
     cursor: pointer;
   }
 
-  &:not(.apos-current-locale):hover {
+  &:not(.apos-current-locale):hover,
+  &:not(.apos-disabled-locale):hover {
     background-color: var(--a-base-10);
   }
 
-  &:not(.apos-current-locale):active {
+  &:not(.apos-current-locale):active,
+  &:not(.apos-disabled-locale):active {
     background-color: var(--a-base-9);
   }
 
@@ -974,11 +984,13 @@ export default {
   }
 
   &.apos-current-locale,
+  &.apos-disabled-locale,
   .apos-current-locale-icon {
     color: var(--a-base-5);
   }
 
-  &.apos-current-locale {
+  &.apos-current-locale,
+  &.apos-disabled-locale {
     font-style: italic;
   }
 

package/modules/@apostrophecms/image/ui/apos/components/AposMediaManagerEditor.vue

@@ -158,7 +158,7 @@ export default {
       return window.apos.modules[this.activeMedia.type] || {};
     },
     canLocalize() {
-      return (Object.keys(apos.i18n.locales).length > 1) && this.moduleOptions.localized && this.activeMedia._id;
+      return this.moduleOptions.canLocalize && this.activeMedia._id;
     },
     moreMenu() {
       const menu = [ {

package/modules/@apostrophecms/modal/ui/apos/apps/AposModals.js

@@ -31,6 +31,38 @@ export default function() {
       },
       getProperties(id) {
         return this.$refs.modals.getProperties(id);
+      },
+      // Returns true if el1 is "on top of" el2 in the
+      // modal stack, as viewed by the user. If el1 is a
+      // modal that appears later in the stack than el2
+      // (visually stacked on top), this method returns true.
+      // If el2 is `document` and el1 is a modal, this
+      // method returns true. For convenenience, if el1
+      // or el2 is not a modal, it is treated as its DOM
+      // parent modal, or as `document`. If el1 has no
+      // parent modal this method always returns false.
+      onTopOf(el1, el2) {
+        if (!el1.matches('[data-apos-modal]')) {
+          el1 = el1.closest('[data-apos-modal]') || document;
+        }
+        if (!el2.matches('[data-apos-modal]')) {
+          el2 = el2.closest('[data-apos-modal]') || document;
+        }
+        if (el1 === document) {
+          return false;
+        }
+        if (el2 === document) {
+          return true;
+        }
+        const index1 = apos.modal.stack.findIndex(modal => modal.$el === el1);
+        const index2 = apos.modal.stack.findIndex(modal => modal.$el === el2);
+        if (index1 === -1) {
+          throw new Error('apos.modal.onTopOf: el1 is not in the modal stack');
+        }
+        if (index2 === -1) {
+          throw new Error('apos.modal.onTopOf: el2 is not in the modal stack');
+        }
+        return index1 > index2;
       }
     },
     render(h) {
@@ -45,6 +77,7 @@ export default function() {
   apos.modal.execute = theAposModals.execute;
   apos.modal.getAt = theAposModals.getAt;
   apos.modal.getProperties = theAposModals.getProperties;
+  apos.modal.onTopOf = theAposModals.onTopOf;
   apos.modal.stack = [];
   apos.confirm = theAposModals.confirm;
   apos.alert = theAposModals.alert;

package/modules/@apostrophecms/modal/ui/apos/components/AposModal.vue

@@ -12,6 +12,7 @@
       aria-modal="true"
       :aria-labelledby="id"
       ref="modalEl"
+      data-apos-modal
     >
       <transition :name="transitionType">
         <div

package/modules/@apostrophecms/modal/ui/apos/components/TheAposModals.vue

@@ -1,5 +1,7 @@
 <template>
-  <div id="apos-modals" :class="themeClass">
+  <div
+    id="apos-modals" :class="themeClass"
+  >
     <component
       v-for="modal in stack" :key="modal.id"
       :is="modal.componentName"

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

@@ -24,6 +24,7 @@ export default {
       },
       serverErrors: null,
       restoreOnly: false,
+      readOnly: false,
       changed: [],
       externalConditionsResults: {}
     };
@@ -32,7 +33,7 @@ export default {
   computed: {
     schema() {
       let schema = (this.moduleOptions.schema || []).filter(field => apos.schema.components.fields[field.type]);
-      if (this.restoreOnly) {
+      if (this.restoreOnly || this.readOnly) {
         schema = klona(schema);
         for (const field of schema) {
           field.readOnly = true;
@@ -251,11 +252,14 @@ export default {
             result = false;
             break;
           }
-          if (Array.isArray(self.getFieldValue(key))) {
-            result = self.getFieldValue(key).includes(val);
+
+          const fieldValue = self.getFieldValue(key);
+
+          if (Array.isArray(fieldValue)) {
+            result = fieldValue.includes(val);
             break;
           }
-          if (val !== self.getFieldValue(key)) {
+          if (val !== fieldValue) {
             result = false;
             break;
           }

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

@@ -48,10 +48,11 @@ export default {
         if (key !== 'utility') {
           tabs.push({
             name: key,
-            label: this.groups[key].label
+            label: this.groups[key].label,
+            fields: this.groups[key].fields
           });
         }
-      };
+      }
 
       return tabs;
     }

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

@@ -802,6 +802,17 @@ module.exports = {
         }
       },
 
+      // Modules that have REST APIs use this method
+      // to determine if a request is qualified to access
+      // it without restriction to the `publicApiProjection`
+      canAccessApi(req) {
+        if (self.options.guestApiAccess) {
+          return !!req.user;
+        } else {
+          return self.apos.permission.can(req, 'view-draft');
+        }
+      },
+
       // Merge in the event emitter / responder capabilities
       ...require('./lib/events.js')(self)
     };