apostrophe 3.33.0 → 3.35.0

package/.github/workflows/main.yml

@@ -38,6 +38,9 @@ jobs:
         with:
           mongodb-version: ${{ matrix.mongodb-version }}
 
+      # Exit status must be succesful in the end
+      - run:  ( ( node --version | grep v14 ) && npm install -g npm@8 ) || echo "npm OK"
+
       - run: npm install
 
       - run: npm test

package/CHANGELOG.md

@@ -1,11 +1,42 @@
 # Changelog
 
+
+## 3.35.0 (2022-12-21)
+
+### Adds
+
+* Introduced support for linking directly to other Apostrophe documents in a rich text widget. The user can choose to link to a URL, or to a page. Linking to various piece types can also be enabled with the `linkWithType` option. This is equivalent to the old `apostrophe-rich-text-permalinks` module but is included in the core in A3. See the [documentation](https://v3.docs.apostrophecms.org/guide/core-widgets.html#rich-text-widget) for details.
+* Introduced support for the `anchor` toolbar control in the rich text editor. This allows named anchors to be inserted. These are rendered as `span` tags with the given `id` and can then be linked to via `#id`, providing basic support for internal links. HTML 4-style named anchors in legacy content (`name` on `a` tags) are automatically migrated upon first edit.
+* German translation i18n file created for the Apostrophe Admin-UI. Thanks to [Noah Gysin](https://github.com/NoahGysin) for this contribution.
+* Introduced support for keyboard shortcuts in admin UI. Hitting `?` will display the list of available shortcuts. Developpers can define their own shortcuts by using the new `@apostrophecms/command-menu` module and the `commands` property. Please check the [keyboard shortcut documentation](https://v3.docs.apostrophecms.org/guide/command-menu.html) for more details.
+
+### Fixes
+
+* The `bulletList` and `orderedList` TipTap toolbar items now work as expected.
+* When using the autocomplete/typeahead feature of relationship fields, typing a space at the start no longer results in an error.
+* Replace [`credential`](https://www.npmjs.com/package/credential) package with [`credentials`](https://www.npmjs.com/package/credentials) to fix the [`mout` Prototype Pollution vulnerability](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-7792). There was no actual vulnerability in Apostrophe or credential due to the way the module was actually used, and this was done to address vulnerability scan reports.
+* Added a basic implementation of the missing "Paste from Clipboard" option to Expanded Widget Previews.
+
+
+## 3.34.0 (2022-12-12)
+
+### Fixes
+
+* Nested areas work properly in widgets that have the `initialModal: false` property.
+* Apostrophe's search index now properly incorporates most string field types as in A2.
+
+### Adds
+
+* Relationships load more quickly.
+* Parked page checks at startup are faster.
+* Tasks to localize and unlocalize piece type content (see `node app help [yourModuleName]:localize` and `node app help [yourModuleName]:unlocalize`).
 ## 3.33.0 (2022-11-28)
 
 ### Adds
 
 * You can now set `inline: true` on schema fields of type `array`. This displays a simple editing interface in the context of the main dialog box for the document in question, avoiding the need to open an additional dialog box. Usually best for cases with just one field or just a few. If your array field has a large number of subfields the default behavior (`inline: false`) is more suitable for your needs. See the [array field](https://v3.docs.apostrophecms.org/reference/field-types/array.html) documentation for more information.
 * Batch feature for publishing pieces.
+* Add extensibility for `rich-text-widget` `defaultOptions`. Every key will now be used in the `AposRichTextWidgetEditor`.
 
 ### Fixes
 

package/defaults.js

@@ -51,6 +51,7 @@ module.exports = {
     '@apostrophecms/file': {},
     '@apostrophecms/file-tag': {},
     '@apostrophecms/soft-redirect': {},
-    '@apostrophecms/submitted-draft': {}
+    '@apostrophecms/submitted-draft': {},
+    '@apostrophecms/command-menu': {}
   }
 };

package/index.js

@@ -537,7 +537,8 @@ async function apostrophe(options, telemetry, rootSpan) {
         'extendQueries',
         'icons',
         'i18n',
-        'webpack'
+        'webpack',
+        'commands'
       ]
     });
 

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

@@ -13,6 +13,80 @@ module.exports = {
     // Do include a page tree button in the admin bar
     pageTree: true
   },
+  commands(self) {
+    return {
+      add: {
+        [`${self.__meta.name}:undo`]: {
+          type: 'item',
+          label: 'apostrophe:commandMenuUndo',
+          action: {
+            type: 'command-menu-admin-bar-undo'
+          },
+          shortcut: 'Ctrl+Z Meta+Z'
+        },
+        [`${self.__meta.name}:redo`]: {
+          type: 'item',
+          label: 'apostrophe:commandMenuRedo',
+          action: {
+            type: 'command-menu-admin-bar-redo'
+          },
+          shortcut: 'Ctrl+Shift+Z Meta+Shift+Z'
+        },
+        [`${self.__meta.name}:discard-draft`]: {
+          type: 'item',
+          label: 'apostrophe:commandMenuDiscardDraft',
+          action: {
+            type: 'command-menu-admin-bar-discard-draft'
+          },
+          shortcut: 'Ctrl+Shift+Backspace Meta+Shift+Backspace'
+        },
+        [`${self.__meta.name}:publish-draft`]: {
+          type: 'item',
+          label: 'apostrophe:commandMenuPublishDraft',
+          action: {
+            type: 'command-menu-admin-bar-publish-draft'
+          },
+          shortcut: 'Ctrl+Shift+P Meta+Shift+P'
+        },
+        [`${self.__meta.name}:toggle-edit-preview-mode`]: {
+          type: 'item',
+          label: 'apostrophe:commandMenuToggleEditPreviewMode',
+          action: {
+            type: 'command-menu-admin-bar-toggle-edit-preview'
+          },
+          shortcut: 'Ctrl+/ Meta+/'
+        },
+        [`${self.__meta.name}:toggle-published-draft-document`]: {
+          type: 'item',
+          label: 'apostrophe:commandMenuTogglePublishedDraftDocument',
+          action: {
+            type: 'command-menu-admin-bar-toggle-publish-draft'
+          },
+          shortcut: 'Ctrl+Shift+D Meta+Shift+D'
+        }
+      },
+      modal: {
+        default: {
+          '@apostrophecms/command-menu:content': {
+            label: 'apostrophe:commandMenuContent',
+            commands: [
+              `${self.__meta.name}:undo`,
+              `${self.__meta.name}:redo`,
+              `${self.__meta.name}:discard-draft`,
+              `${self.__meta.name}:publish-draft`
+            ]
+          },
+          '@apostrophecms/command-menu:mode': {
+            label: 'apostrophe:commandMenuMode',
+            commands: [
+              `${self.__meta.name}:toggle-edit-preview-mode`,
+              `${self.__meta.name}:toggle-published-draft-document`
+            ]
+          }
+        }
+      }
+    };
+  },
   init(self) {
     self.items = [];
     self.groups = [];

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

@@ -3,8 +3,8 @@
     <template v-if="contextBarActive">
       <TheAposContextUndoRedo
         :v-if="editMode"
-        :patches-since-loaded="patchesSinceLoaded"
-        :undone="undone"
+        :can-undo="canUndo"
+        :can-redo="canRedo"
         @undo="undo"
         @redo="redo"
         :retrying="retrying"
@@ -122,6 +122,12 @@ export default {
     },
     customPublishLabel() {
       return (this.hasCustomUi && apos.modules[this.context.type].publishLabel) || null;
+    },
+    canUndo() {
+      return this.patchesSinceLoaded.length > 0;
+    },
+    canRedo() {
+      return this.undone.length > 0;
     }
   },
   watch: {
@@ -598,12 +604,16 @@ export default {
       }
     },
     async undo() {
-      this.undone.push(this.patchesSinceLoaded.pop());
-      await this.refreshAfterHistoryChange('apostrophe:undoFailed');
+      if (this.canUndo) {
+        this.undone.push(this.patchesSinceLoaded.pop());
+        await this.refreshAfterHistoryChange('apostrophe:undoFailed');
+      }
     },
     async redo() {
-      this.patchesSinceLoaded.push(this.undone.pop());
-      await this.refreshAfterHistoryChange('apostrophe:redoFailed');
+      if (this.canRedo) {
+        this.patchesSinceLoaded.push(this.undone.pop());
+        await this.refreshAfterHistoryChange('apostrophe:redoFailed');
+      }
     },
     async refreshAfterHistoryChange(errorMessageKey) {
       this.saving = true;

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

@@ -36,7 +36,7 @@
         :show-preview="false"
       />
       <AposButton
-        v-if="!hasCustomUi"
+        v-if="canSwitchToPreviewMode"
         class="apos-admin-bar__context-button"
         label="apostrophe:preview" :tooltip="{
           content: 'apostrophe:previewTooltip',
@@ -127,16 +127,39 @@ export default {
     },
     hasBeenPublishedThisPageload() {
       return (this.context.lastPublishedAt > this.mountedAt) || ((this.context.submitted && this.context.submitted.at) > this.mountedAt);
+    },
+    canSwitchToEditMode() {
+      return !this.editMode;
+    },
+    canSwitchToPreviewMode() {
+      return this.editMode && !this.hasCustomUI;
     }
   },
   mounted() {
     this.mountedAt = (new Date()).toISOString();
+    apos.bus.$on('command-menu-admin-bar-toggle-edit-preview', this.toggleEditPreviewMode);
+    apos.bus.$on('command-menu-admin-bar-publish-draft', this.onPublish);
+  },
+  destroyed() {
+    apos.bus.$off('command-menu-admin-bar-toggle-edit-preview', this.toggleEditPreviewMode);
+    apos.bus.$off('command-menu-admin-bar-publish-draft', this.onPublish);
   },
   methods: {
+    toggleEditPreviewMode() {
+      if (this.canSwitchToEditMode) {
+        this.switchEditMode(true);
+      } else if (this.canSwitchToPreviewMode) {
+        this.switchEditMode(false);
+      }
+    },
     switchEditMode(mode) {
       this.$emit('switch-edit-mode', mode);
     },
     onPublish() {
+      if (!this.editMode || !this.readyToPublish) {
+        return;
+      }
+
       if (!this.context.lastPublishedAt) {
         this.hasBeenPublishedButNotUpdated = true;
       } else {

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

@@ -102,9 +102,24 @@ export default {
           modifiers: (this.draftMode === 'published') ? [ 'disabled', 'selected' ] : null
         }
       ];
+    },
+    canTogglePublishDraftMode() {
+      return !this.isUnpublished && !this.hasCustomUi;
     }
   },
+  mounted() {
+    apos.bus.$on('command-menu-admin-bar-toggle-publish-draft', this.togglePublishDraftMode);
+  },
+  destroyed() {
+    apos.bus.$off('command-menu-admin-bar-toggle-publish-draft', this.togglePublishDraftMode);
+  },
   methods: {
+    togglePublishDraftMode() {
+      if (this.canTogglePublishDraftMode) {
+        const mode = this.draftMode === 'draft' ? 'published' : 'draft';
+        this.switchDraftMode(mode);
+      }
+    },
     switchDraftMode(mode) {
       this.$emit('switch-draft-mode', mode);
     }

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

@@ -10,7 +10,7 @@
       v-apos-tooltip="undoTooltips.undo"
     >
       <AposButton
-        :disabled="patchesSinceLoaded.length === 0"
+        :disabled="!canUndo"
         type="subtle" :modifiers="['small', 'no-motion']"
         label="apostrophe:undo" class="apos-admin-bar__context-button"
         icon="undo-icon" :icon-only="true"
@@ -22,7 +22,7 @@
       v-apos-tooltip="undoTooltips.redo"
     >
       <AposButton
-        :disabled="undone.length === 0"
+        :disabled="!canRedo"
         type="subtle" :modifiers="['small', 'no-motion']"
         label="apostrophe:redo" class="apos-admin-bar__context-button"
         icon="redo-icon" :icon-only="true"
@@ -44,18 +44,8 @@
 export default {
   name: 'TheAposContextUndoRedo',
   props: {
-    patchesSinceLoaded: {
-      type: Array,
-      default() {
-        return [];
-      }
-    },
-    undone: {
-      type: Array,
-      default() {
-        return [];
-      }
-    },
+    canUndo: Boolean,
+    canRedo: Boolean,
     retrying: Boolean,
     editing: Boolean,
     saving: Boolean,
@@ -69,23 +59,35 @@ export default {
         redo: 'apostrophe:redoTooltip'
       };
 
-      if (this.patchesSinceLoaded.length === 0) {
+      if (!this.canUndo) {
         tooltips.undo = 'apostrophe:undoTooltipNoChanges';
       }
 
-      if (this.undone.length === 0) {
+      if (!this.canRedo) {
         tooltips.redo = 'apostrophe:redoTooltipNoChanges';
       }
 
       return tooltips;
     }
   },
+  mounted() {
+    apos.bus.$on('command-menu-admin-bar-undo', this.undo);
+    apos.bus.$on('command-menu-admin-bar-redo', this.redo);
+  },
+  destroyed() {
+    apos.bus.$off('command-menu-admin-bar-undo', this.undo);
+    apos.bus.$off('command-menu-admin-bar-redo', this.redo);
+  },
   methods: {
     undo() {
-      this.$emit('undo');
+      if (this.canUndo) {
+        this.$emit('undo');
+      }
     },
     redo() {
-      this.$emit('redo');
+      if (this.canRedo) {
+        this.$emit('redo');
+      }
     }
   }
 };

package/modules/@apostrophecms/area/ui/apos/components/AposAreaEditor.vue

@@ -446,9 +446,10 @@ export default {
           index
         });
       } else if (!this.widgetHasInitialModal(name)) {
+        const widget = this.newWidget(name);
         return this.insert({
           widget: {
-            type: name,
+            ...widget,
             aposPlaceholder: this.widgetHasPlaceholder(name)
           },
           index
@@ -561,6 +562,26 @@ export default {
         }
         return window.apos.modules[`${item.type}-widget`];
       });
+    },
+    // Return a new widget object in which defaults are fully populated,
+    // especially valid sub-area objects, so that nested edits work on the page
+    newWidget(type) {
+      const widget = {
+        type
+      };
+      const schema = apos.modules[apos.area.widgetManagers[type]].schema;
+      schema.forEach(field => {
+        if (field.type === 'area') {
+          widget[field.name] = {
+            _id: cuid(),
+            metaType: 'area',
+            items: []
+          };
+        } else {
+          widget[field.name] = field.def ? klona(field.def) : field.def;
+        }
+      });
+      return widget;
     }
   }
 };

package/modules/@apostrophecms/area/ui/apos/components/AposAreaExpandedMenu.vue

@@ -117,11 +117,46 @@ export default {
         'apos.expanded-menu: No groups or widgets defined. Please, either add a groups or widgets property to your area configuration.'
       );
     }
+
+    const clipboard = this.getClipboard();
+    this.groups = clipboard
+      ? [ clipboard ].concat(this.groups)
+      : this.groups;
   },
   methods: {
     isValidColumn(count) {
       return count ? +count > 1 && +count < 4 : true;
     },
+    getClipboard() {
+      const clipboard = apos.area.widgetClipboard.get();
+      if (!clipboard) {
+        return null;
+      }
+
+      const widgets = this.groups.flatMap(group => Object.values(group.widgets));
+      const matchingChoice = widgets.find(widget => widget.name === clipboard.type);
+      if (!matchingChoice) {
+        return null;
+      }
+
+      const group = {
+        label: 'Clipboard',
+        widgets: [
+          {
+            type: 'clipboard',
+            ...matchingChoice,
+            label: {
+              key: 'apostrophe:pasteWidget',
+              widget: this.$t(matchingChoice.label)
+            },
+            clipboard
+          }
+        ],
+        columns: 1
+      };
+
+      return group;
+    },
     createGroup(config) {
       const group = {
         columns: +config.columns || 3,

package/modules/@apostrophecms/area/ui/apos/components/AposAreaWidget.vue

@@ -268,7 +268,12 @@ export default {
       };
     },
     widgetLabel() {
-      return window.apos.modules[`${this.widget.type}-widget`].label;
+      const moduleName = `${this.widget.type}-widget`;
+      const module = window.apos.modules[moduleName];
+      if (!module) {
+        console.error(`No ${moduleName} module found for widget type ${this.widget.type}`);
+      }
+      return module.label;
     },
     widgetOptions() {
       return this.widgets[this.widget.type];

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

@@ -1,19 +1,26 @@
 // Alphabetical collection of globally available vue-material-design-icons.
 module.exports = {
   'account-box-icon': 'AccountBox',
-  'alpha-x-icon': 'AlphaX',
   'alert-circle-icon': 'AlertCircle',
-  'arrow-down-icon': 'ArrowDown',
-  'arrow-up-icon': 'ArrowUp',
+  'alpha-x-icon': 'AlphaX',
+  'anchor-icon': 'Anchor',
+  'apple-keyboard-caps': 'AppleKeyboardCaps',
+  'apple-keyboard-command': 'AppleKeyboardCommand',
+  'apple-keyboard-control': 'AppleKeyboardControl',
+  'apple-keyboard-option': 'AppleKeyboardOption',
+  'apple-keyboard-shift': 'AppleKeyboardShift',
   'archive-arrow-down-icon': 'ArchiveArrowDown',
   'archive-arrow-up-icon': 'ArchiveArrowUp',
+  'arrow-down-icon': 'ArrowDown',
+  'arrow-left-icon': 'ArrowLeft',
   'arrow-right-icon': 'ArrowRight',
+  'arrow-up-icon': 'ArrowUp',
   'calendar-icon': 'Calendar',
-  'checkbox-blank-icon': 'CheckboxBlankOutline',
   'check-all-icon': 'CheckAll',
   'check-bold-icon': 'CheckBold',
   'check-circle-icon': 'CheckCircle',
   'check-decagram-icon': 'CheckDecagram',
+  'checkbox-blank-icon': 'CheckboxBlankOutline',
   'checkbox-marked-icon': 'CheckboxMarked',
   'chevron-down-icon': 'ChevronDown',
   'chevron-left-icon': 'ChevronLeft',
@@ -21,57 +28,74 @@ module.exports = {
   'chevron-up-icon': 'ChevronUp',
   'circle-icon': 'Circle',
   'circle-medium-icon': 'CircleMedium',
+  'clipboard-plus-icon': 'ClipboardPlus',
+  'clipboard-plus-outline-icon': 'ClipboardPlusOutline',
   'clock-icon': 'Clock',
   'close-circle-icon': 'CloseCircle',
   'close-icon': 'Close',
   'cloud-upload-icon': 'CloudUpload',
   'code-tags-icon': 'CodeTags',
   'cog-icon': 'Cog',
-  'cursor-default-click-icon': 'CursorDefaultClick',
   'content-copy-icon': 'ContentCopy',
-  'clipboard-plus-icon': 'ClipboardPlus',
-  'clipboard-plus-outline-icon': 'ClipboardPlusOutline',
-  'delete-icon': 'Delete',
   'content-cut-icon': 'ContentCut',
+  'cursor-default-click-icon': 'CursorDefaultClick',
+  'delete-icon': 'Delete',
   'dots-vertical-icon': 'DotsVertical',
   'drag-icon': 'Apps',
   'eye-icon': 'Eye',
-  'file-tree-icon': 'FileTree',
   'file-document-icon': 'FileDocument',
+  'file-tree-icon': 'FileTree',
   'flare-icon': 'Flare',
   'format-align-center-icon': 'FormatAlignCenter',
   'format-align-justify-icon': 'FormatAlignJustify',
   'format-align-left-icon': 'FormatAlignLeft',
   'format-align-right-icon': 'FormatAlignRight',
   'format-bold-icon': 'FormatBold',
+  'format-italic-icon': 'FormatItalic',
   'format-list-bulleted-icon': 'FormatListBulleted',
   'format-list-numbered-icon': 'FormatListNumbered',
-  'format-italic-icon': 'FormatItalic',
+  'format-quote-close-icon': 'FormatQuoteClose',
   'format-strikethrough-variant-icon': 'FormatStrikethroughVariant',
   'format-underline-icon': 'FormatUnderline',
-  'format-quote-close-icon': 'FormatQuoteClose',
   'help-circle-icon': 'HelpCircle',
-  'information-outline-icon': 'InformationOutline',
-  'information-icon': 'Information',
   'image-edit-outline': 'ImageEditOutline',
   'image-icon': 'Image',
   'image-size-select-actual-icon': 'ImageSizeSelectActual',
-  'play-box-icon': 'PlayBox',
+  'information-icon': 'Information',
+  'information-outline-icon': 'InformationOutline',
   'instagram-icon': 'Instagram',
+  'keyboard-backspace': 'KeyboardBackspace',
+  'keyboard-esc': 'KeyboardEsc',
+  'keyboard-f1': 'KeyboardF1',
+  'keyboard-f10': 'KeyboardF10',
+  'keyboard-f11': 'KeyboardF11',
+  'keyboard-f12': 'KeyboardF12',
+  'keyboard-f2': 'KeyboardF2',
+  'keyboard-f3': 'KeyboardF3',
+  'keyboard-f4': 'KeyboardF4',
+  'keyboard-f5': 'KeyboardF5',
+  'keyboard-f6': 'KeyboardF6',
+  'keyboard-f7': 'KeyboardF7',
+  'keyboard-f8': 'KeyboardF8',
+  'keyboard-f9': 'KeyboardF9',
+  'keyboard-return': 'KeyboardReturn',
+  'keyboard-space': 'KeyboardSpace',
+  'keyboard-tab': 'KeyboardTab',
   'label-icon': 'Label',
   'lightbulb-on-icon': 'LightbulbOn',
   'link-icon': 'Link',
   'list-status-icon': 'ListStatus',
   'lock-icon': 'Lock',
-  'map-marker-icon': 'MapMarker',
   'magnify-icon': 'Magnify',
+  'map-marker-icon': 'MapMarker',
   'menu-down-icon': 'MenuDown',
-  'minus-icon': 'Minus',
   'minus-box-icon': 'MinusBox',
+  'minus-icon': 'Minus',
   'paperclip-icon': 'Paperclip',
   'pencil-icon': 'Pencil',
-  'plus-icon': 'Plus',
   'phone-icon': 'Phone',
+  'play-box-icon': 'PlayBox',
+  'plus-icon': 'Plus',
   'redo-icon': 'RedoVariant',
   'refresh-icon': 'Refresh',
   'sign-text-icon': 'SignText',