apostrophe 4.1.0 → 4.2.0

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

@@ -11,10 +11,10 @@
       :class="classes"
       role="dialog"
       aria-modal="true"
-      :aria-labelledby="id"
+      :aria-labelledby="state.id"
       data-apos-modal
-      @keydown="cycleElementsToFocus"
       @focus.capture="storeFocusedElement"
+      @keydown="onKeydown"
     >
       <transition :name="transitionType">
         <div
@@ -41,16 +41,16 @@
           <template v-else>
             <header v-if="!modal.disableHeader" class="apos-modal__header">
               <div class="apos-modal__header__main">
-                <div v-if="hasSecondaryControls" class="apos-modal__controls--secondary">
+                <div v-if="hasSlot('secondaryControls')" class="apos-modal__controls--secondary">
                   <slot name="secondaryControls" />
                 </div>
-                <h2 :id="id" class="apos-modal__heading">
+                <h2 :id="state.id" class="apos-modal__heading">
                   <span v-if="modal.a11yTitle" class="apos-sr-only">
                     {{ $t(modal.a11yTitle) }}
                   </span>
                   {{ $t(modalTitle) }}
                 </h2>
-                <div v-if="hasBeenLocalized || hasPrimaryControls" class="apos-modal__controls--header">
+                <div v-if="hasBeenLocalized || hasSlot('primaryControls')" class="apos-modal__controls--header">
                   <div v-if="hasBeenLocalized" class="apos-modal__locale">
                     <span class="apos-modal__locale-label">
                       {{ $t('apostrophe:locale') }}:
@@ -58,21 +58,21 @@
                       {{ currentLocale }}
                     </span>
                   </div>
-                  <div v-if="hasPrimaryControls" class="apos-modal__controls--primary">
+                  <div v-if="hasSlot('primaryControls')" class="apos-modal__controls--primary">
                     <slot name="primaryControls" />
                   </div>
                 </div>
               </div>
-              <div v-if="hasBreadcrumbs" class="apos-modal__breadcrumbs">
+              <div v-if="hasSlot('breadcrumbs')" class="apos-modal__breadcrumbs">
                 <slot class="apos-modal__breadcrumbs" name="breadcrumbs" />
               </div>
             </header>
             <div class="apos-modal__main" :class="gridModifier">
-              <slot v-if="hasLeftRail" name="leftRail" />
+              <slot name="leftRail" />
               <slot name="main" />
               <slot name="rightRail" />
             </div>
-            <footer v-if="hasFooter" class="apos-modal__footer">
+            <footer v-if="hasSlot('footer')" class="apos-modal__footer">
               <div class="apos-modal__footer__inner">
                 <slot name="footer" />
               </div>
@@ -84,7 +84,7 @@
   </transition>
 </template>
 
-<script>
+<script setup>
 // NOTE:
 // To get the desired transition effect, modal props have two properties,
 // `active` and `showModal`, which control their visibility. Basically,
@@ -94,186 +94,187 @@
 // So as the modal exits, they should change in reverse. `showModal` becomes
 // `false`, then `active` is set to `false` once the modal has finished its
 // transition.
-import AposFocusMixin from 'Modules/@apostrophecms/modal/mixins/AposFocusMixin';
-
-export default {
-  name: 'AposModal',
-  mixins: [
-    AposFocusMixin
-  ],
-  props: {
-    modal: {
-      type: Object,
-      required: true
-    },
-    modalTitle: {
-      type: [ String, Object ],
-      default: ''
-    }
-  },
-  emits: [ 'inactive', 'esc', 'show-modal', 'no-modal', 'ready' ],
-  data() {
-    return {
-      // For aria purposes
-      id: 'modal:' + Math.random().toString().replace('.', '')
-    };
-  },
-  computed: {
-    transitionType: function () {
-      if (this.modal.type === 'slide') {
-        if (this.modal.origin === 'left') {
-          return 'slide-right';
-        } else {
-          return 'slide-left';
-        }
-      } else {
-        return 'fade';
-      }
-    },
-    shouldTrapFocus() {
-      return this.modal.trapFocus || this.modal.trapFocus === undefined;
-    },
-    triggerFocusRefresh () {
-      return this.modal.triggerFocusRefresh;
-    },
-    hasBeenLocalized: function() {
-      return Object.keys(apos.i18n.locales).length > 1;
-    },
-    currentLocale: function() {
-      return apos.i18n.locale;
-    },
-    hasPrimaryControls: function () {
-      return !!this.$slots.primaryControls;
-    },
-    hasSecondaryControls: function () {
-      return !!this.$slots.secondaryControls;
-    },
-    hasBreadcrumbs: function () {
-      return !!this.$slots.breadcrumbs;
-    },
-    hasLeftRail: function () {
-      return !!this.$slots.leftRail;
-    },
-    hasRightRail: function () {
-      return !!this.$slots.rightRail;
-    },
-    hasFooter: function () {
-      return !!this.$slots.footer;
-    },
-    classes() {
-      const classes = [ 'apos-modal' ];
-      classes.push(`apos-modal--${this.modal.type}`);
-      if (this.modal.type === 'slide') {
-        if (this.modal.origin) {
-          classes.push(`apos-modal--origin-${this.modal.origin}`);
-        } else {
-          classes.push('apos-modal--origin-right');
-        }
-        classes.push('apos-modal--full-height');
-      }
-      if (this.modal.busy) {
-        classes.push('apos-modal--busy');
-      }
-      return classes.join(' ');
-    },
-    innerClasses() {
-      const classes = [];
-      if (this.modal.width) {
-        classes.push(`apos-modal__inner--${this.modal.width}`);
-      };
-      return classes;
-    },
-    gridModifier() {
-      if (this.hasLeftRail && this.hasRightRail) {
-        return 'apos-modal__main--with-rails';
-      }
-      if (this.hasLeftRail && !this.hasRightRail) {
-        return 'apos-modal__main--with-left-rail';
-      }
-      if (!this.hasLeftRail && this.hasRightRail) {
-        return 'apos-modal__main--with-right-rail';
-      }
-      return false;
-    }
-  },
-  watch: {
-    // Simple way to re-trigger focusable elements
-    // that might have been created or removed
-    // after an update, like an XHR call to get the
-    // pieces list in the AposDocsManager modal, for instance.
-    triggerFocusRefresh (newVal) {
-      if (this.shouldTrapFocus) {
-        this.$nextTick(this.trapFocus);
-      }
-    }
-  },
-  mounted() {
-    if (this.shouldTrapFocus) {
-      this.$nextTick(this.trapFocus);
-    }
+
+import {
+  ref, reactive, onMounted, computed, watch, nextTick, useSlots
+} from 'vue';
+import { useAposFocus } from 'Modules/@apostrophecms/modal/composables/AposFocus';
+import cuid from 'cuid';
+
+const {
+  cycleElementsToFocus,
+  elementsToFocus,
+  focusElement,
+  focusLastModalFocusedElement,
+  focusedElement,
+  isElementVisible,
+  storeFocusedElement
+} = useAposFocus();
+
+const props = defineProps({
+  modal: {
+    type: Object,
+    required: true
   },
-  methods: {
-    onKeydown (e) {
-      const hasPressedEsc = e.keyCode === 27;
-      if (hasPressedEsc) {
-        this.close(e);
-      }
-    },
-    onEnter () {
-      this.$emit('show-modal');
-      this.bindEventListeners();
-      apos.modal.stack = apos.modal.stack || [];
-      apos.modal.stack.push(this);
-      this.$nextTick(() => {
-        this.$emit('ready');
-      });
-    },
-    onLeave () {
-      this.removeEventListeners();
-      this.$emit('no-modal');
-      // pop doesn't quite suffice because of race conditions when
-      // closing one and opening another
-      apos.modal.stack = apos.modal.stack.filter(modal => modal !== this);
-      this.focusLastModalFocusedElement();
-    },
-    bindEventListeners () {
-      window.addEventListener('keydown', this.onKeydown);
-    },
-    removeEventListeners () {
-      window.removeEventListener('keydown', this.onKeydown);
-    },
-    close (e) {
-      if (apos.modal.stack[apos.modal.stack.length - 1] !== this) {
-        return;
-      }
-      e.stopPropagation();
-      this.$emit('esc');
-    },
-    trapFocus () {
-      const elementSelectors = [
-        '[tabindex]',
-        '[href]',
-        'input',
-        'select',
-        'textarea',
-        'button'
-      ];
-
-      const selector = elementSelectors
-        .map(addExcludingAttributes)
-        .join(', ');
-
-      this.elementsToFocus = [ ...this.$refs.modalEl.querySelectorAll(selector) ]
-        .filter(this.isElementVisible);
-
-      this.focusElement(this.focusedElement, this.elementsToFocus[0]);
-
-      function addExcludingAttributes(element) {
-        return `${element}:not([tabindex="-1"]):not([disabled]):not([type="hidden"]):not([aria-hidden])`;
-      }
+  modalTitle: {
+    type: [ String, Object ],
+    default: ''
+  }
+});
+
+const slots = useSlots();
+const emit = defineEmits([ 'inactive', 'esc', 'show-modal', 'no-modal', 'ready' ]);
+const modalEl = ref(null);
+const state = reactive({
+  id: `modal:${cuid()}`,
+  elementsToFocus,
+  focusedElement,
+  modalEl
+});
+
+const transitionType = computed(() => {
+  if (props.modal.type !== 'slide') {
+    return 'fade';
+  }
+
+  if (props.modal.origin === 'left') {
+    return 'slide-right';
+  } else {
+    return 'slide-left';
+  }
+});
+
+const shouldTrapFocus = computed(() => {
+  return props.modal.trapFocus || props.modal.trapFocus === undefined;
+});
+
+const triggerFocusRefresh = computed(() => {
+  return props.modal.triggerFocusRefresh;
+});
+
+const hasBeenLocalized = computed(() => {
+  return Object.keys(apos.i18n.locales).length > 1;
+});
+
+const currentLocale = computed(() => {
+  return apos.i18n.locale;
+});
+
+function hasSlot(slotName) {
+  return Boolean(slots[slotName]);
+}
+
+const classes = computed(() => {
+  const classes = [ 'apos-modal' ];
+  classes.push(`apos-modal--${props.modal.type}`);
+  if (props.modal.type === 'slide') {
+    if (props.modal.origin) {
+      classes.push(`apos-modal--origin-${props.modal.origin}`);
+    } else {
+      classes.push('apos-modal--origin-right');
     }
+    classes.push('apos-modal--full-height');
+  }
+  if (props.modal.busy) {
+    classes.push('apos-modal--busy');
+  }
+  return classes.join(' ');
+});
+
+const innerClasses = computed(() => {
+  const classes = [];
+  if (props.modal.width) {
+    classes.push(`apos-modal__inner--${props.modal.width}`);
+  };
+
+  return classes;
+});
+
+const gridModifier = computed(() => {
+  const hasLeftRail = hasSlot('leftRail');
+  const hasRightRail = hasSlot('rightRail');
+
+  if (hasLeftRail && hasRightRail) {
+    return 'apos-modal__main--with-rails';
+  }
+  if (hasLeftRail && !hasRightRail) {
+    return 'apos-modal__main--with-left-rail';
+  }
+  if (!hasLeftRail && hasRightRail) {
+    return 'apos-modal__main--with-right-rail';
+  }
+  return false;
+});
+
+watch(triggerFocusRefresh, (newVal) => {
+  if (shouldTrapFocus.value) {
+    nextTick(trapFocus);
+  }
+});
+
+onMounted(() => {
+  if (shouldTrapFocus.value) {
+    nextTick(trapFocus);
+  }
+});
+
+function onKeydown(e) {
+  const hasPressedEsc = e.keyCode === 27;
+  if (hasPressedEsc) {
+    close(e);
+  }
+  cycleElementsToFocus(e);
+}
+
+function onEnter() {
+  emit('show-modal');
+  apos.modal.stack = apos.modal.stack || [];
+
+  apos.modal.stack.push(state);
+  nextTick(() => {
+    emit('ready');
+  });
+}
+
+function onLeave() {
+  emit('no-modal');
+
+  apos.modal.stack = apos.modal.stack
+    .filter(modal => modal.id !== state.id);
+
+  focusLastModalFocusedElement();
+}
+
+function trapFocus() {
+  const elementSelectors = [
+    '[tabindex]',
+    '[href]',
+    'input',
+    'select',
+    'textarea',
+    'button'
+  ];
+
+  const selector = elementSelectors
+    .map(addExcludingAttributes)
+    .join(', ');
+
+  elementsToFocus.value = [ ...modalEl.value.querySelectorAll(selector) ]
+    .filter(isElementVisible);
+
+  focusElement(focusedElement.value, elementsToFocus.value[0]);
+
+  function addExcludingAttributes(element) {
+    return `${element}:not([tabindex="-1"]):not([disabled]):not([type="hidden"]):not([aria-hidden])`;
+  }
+}
+
+function close() {
+  if (apos.modal.stack.at(-1)?.id !== state.id) {
+    return;
   }
-};
+  emit('esc');
+}
 </script>
 
 <style lang="scss" scoped>

package/modules/@apostrophecms/modal/ui/apos/composables/AposFocus.js

@@ -8,7 +8,7 @@ export function useAposFocus() {
     elementsToFocus,
     focusedElement,
     cycleElementsToFocus,
-    focuslastmodalfocusedelement,
+    focusLastModalFocusedElement,
     storeFocusedElement,
     focusElement,
     isElementVisible
@@ -56,7 +56,7 @@ export function useAposFocus() {
   // Focus the last focused element from the last modal.
   // If it is not focusable (not visible/not in the DOM),
   // fallbacks to the first focusable element from the last modal.
-  function focuslastmodalfocusedelement() {
+  function focusLastModalFocusedElement() {
     const lastModal = apos.modal.stack.at(-1);
 
     if (!lastModal) {

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

@@ -271,6 +271,8 @@ module.exports = {
           throw self.apos.error('required');
         }
 
+        req.body = req.body || {};
+
         const notification = {
           _id: self.apos.util.generateId(),
           createdAt: new Date(),

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

@@ -405,11 +405,11 @@ export default {
     },
     shortcutNew(event) {
       const interesting = event.keyCode === 78; // N(ew)
-      const topModal = apos.modal.stack[apos.modal.stack.length - 1] ? apos.modal.stack[apos.modal.stack.length - 1].id : null;
+      const topModalId = apos.modal.stack.at(-1)?.id;
       if (
         interesting &&
         document.activeElement.tagName !== 'INPUT' &&
-        this.$refs.modal.id === topModal
+        this.$refs.modal.id === topModalId
       ) {
         this.create();
       }

package/modules/@apostrophecms/rich-text-widget/index.js

@@ -142,9 +142,15 @@ module.exports = {
       widgetEditor: 'AposRichTextWidgetEditor'
     },
     editorTools: {
-      styles: {
+      nodes: {
         component: 'AposTiptapStyles',
-        label: 'apostrophe:richTextStyles'
+        label: 'apostrophe:richTextNodeStyles',
+        icon: 'format-text-icon'
+      },
+      marks: {
+        component: 'AposTiptapMarks',
+        label: 'apostrophe:richTextMarkStyles',
+        icon: 'palette-swatch-icon'
       },
       table: {
         component: 'AposTiptapTable',
@@ -311,9 +317,10 @@ module.exports = {
       setNode: [ 'p', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'pre', 'div' ],
       toggleMark: [
         'b', 'strong', 'code', 'mark', 'em', 'i',
-        'a', 's', 'del', 'strike', 'span', 'u', 'anchor',
+        'a', 's', 'del', 'strike', 'u', 'anchor',
         'superscript', 'subscript'
       ],
+      toggleClassOrToggleMark: [ 'span' ],
       wrapIn: [ 'blockquote' ]
     },
     tiptapTypes: {
@@ -347,7 +354,8 @@ module.exports = {
   icons: {
     'format-text-icon': 'FormatText',
     'format-color-highlight-icon': 'FormatColorHighlight',
-    'table-icon': 'Table'
+    'table-icon': 'Table',
+    'palette-swatch-icon': 'PaletteSwatch'
   },
   handlers(self) {
     return {
@@ -609,9 +617,13 @@ module.exports = {
           for (const style of options.styles || []) {
             const tag = style.tag;
             const classes = self.getStyleClasses(style);
-            allowedClasses[tag] = allowedClasses[tag] || {};
-            for (const c of classes) {
-              allowedClasses[tag][c] = true;
+
+            // Add classes to THIS tag's allowList
+            if (tag) {
+              allowedClasses[tag] = allowedClasses[tag] || {};
+              for (const c of classes) {
+                allowedClasses[tag][c] = true;
+              }
             }
           }
         }
@@ -867,7 +879,6 @@ module.exports = {
       // Add on the core default options to use, if needed.
       getBrowserData(_super, req) {
         const initialData = _super(req);
-
         const finalData = {
           ...initialData,
           tools: self.options.editorTools,

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

@@ -8,7 +8,8 @@
         duration: 300,
         zIndex: 2000,
         animation: 'fade',
-        inertia: true
+        inertia: true,
+        placement: 'bottom'
       }"
       :editor="editor"
     >
@@ -140,6 +141,8 @@ import TableHeader from '@tiptap/extension-table-header';
 import TableRow from '@tiptap/extension-table-row';
 import Placeholder from '@tiptap/extension-placeholder';
 
+import { klona } from 'klona';
+
 export default {
   name: 'AposRichTextWidgetEditor',
   components: {
@@ -209,13 +212,20 @@ export default {
       return this.moduleOptions.defaultOptions;
     },
     editorOptions() {
-      const activeOptions = Object.assign({}, this.options);
-
-      activeOptions.styles = this.enhanceStyles(
-        activeOptions.styles?.length
-          ? activeOptions.styles
-          : this.defaultOptions.styles
-      );
+      // Deep clone to prevent runaway recursive rendering
+      // as the subproperties are mutated in several places
+      // by this code and its dependencies
+      let activeOptions = klona(this.options);
+
+      activeOptions = {
+        ...activeOptions,
+        ...this.enhanceStyles(
+          activeOptions.styles?.length
+            ? activeOptions.styles
+            : this.defaultOptions.styles
+        )
+      };
+      delete activeOptions.styles;
 
       // Allow default options to pass through if `false`
       Object.keys(this.defaultOptions).forEach((option) => {
@@ -228,6 +238,15 @@ export default {
       activeOptions.className = (activeOptions.className !== undefined)
         ? activeOptions.className : this.moduleOptions.className;
 
+      if (activeOptions.toolbar.includes('styles')) {
+        activeOptions.toolbar = activeOptions.toolbar.filter(t => t !== 'styles');
+        if (activeOptions.marks.length) {
+          activeOptions.toolbar = [ 'marks', ...activeOptions.toolbar ];
+        }
+        if (activeOptions.nodes.length) {
+          activeOptions.toolbar = [ 'nodes', ...activeOptions.toolbar ];
+        }
+      }
       return activeOptions;
     },
     autofocus() {
@@ -243,7 +262,12 @@ export default {
       // If we don't supply a valid instance of the first style, then
       // the text align control will not work until the user manually
       // applies a style or refreshes the page
-      const defaultStyle = this.editorOptions.styles.find(style => style.def);
+      const defaultStyle =
+        this.editorOptions.nodes.length
+          ? this.editorOptions.nodes.find(style => style.def)
+          : this.editorOptions.marks.length
+            ? this.editorOptions.marks.find(style => style.def)
+            : null;
 
       const _class = defaultStyle.class ? ` class="${defaultStyle.class}"` : '';
       return `<${defaultStyle.tag}${_class}></${defaultStyle.tag}>`;
@@ -491,6 +515,7 @@ export default {
     },
     // Enhances the dev-defined styles list with tiptap
     // commands and parameters used internally.
+    // WARNING: mutates its argument
     enhanceStyles(styles) {
       const self = this;
       (styles || []).forEach(style => {
@@ -541,11 +566,15 @@ export default {
           styles[0].def = true;
         }
       }
-      return styles;
+
+      // Split styles into node and mark selects
+      const result = {
+        nodes: styles.filter(style => style.command === 'setNode'),
+        marks: styles.filter(style => style.command !== 'setNode')
+      };
+      return result;
     },
     localizeStyle(style) {
-      style.label = this.$t(style.label);
-
       return {
         ...style,
         label: this.$t(style.label)
@@ -555,7 +584,8 @@ export default {
       return (apos.tiptapExtensions || [])
         .map(extension => extension({
           ...this.editorOptions,
-          styles: this.editorOptions.styles.map(this.localizeStyle),
+          nodes: this.editorOptions.nodes.map(this.localizeStyle),
+          marks: this.editorOptions.marks.map(this.localizeStyle),
           types: this.tiptapTypes
         }));
     },
@@ -713,13 +743,16 @@ function traverseNextNode(node) {
 
     .apos-button--rich-text {
       position: relative;
-      width: 24px;
       height: 24px;
-      padding: 0;
+      padding: 0 8px;
       border: none;
       border-radius: var(--a-border-radius);
       background-color: transparent;
       color: var(--a-base-1);
+      &.apos-button--icon-only {
+        width: 24px;
+        padding: 0;
+      }
       &:hover {
         background-color: transparent;
       }
@@ -775,7 +808,7 @@ function traverseNextNode(node) {
     align-items: stretch;
     max-width: 100%;
     height: auto;
-    gap: 4px;
+    gap: 6px;
   }
 
   .apos-rich-text-editor__editor :deep(.ProseMirror) {