apostrophe 3.35.0 → 3.37.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## 3.37.0 (2023-01-06)
+
+### Adds
+
+* Dynamic choice functions in schemas now also receive a data object with their original doc id for further inspection by your function.
+* Use `mergeWithCustomize` when merging extended source Webpack configuration. Introduce overideable asset module methods `srcCustomizeArray` and `srcCustomizeObject`, with reasonable default behavior, for fine tuning Webpack config arrays and objects merging. More info - [the Webpack mergeWithCustomize docs](https://github.com/survivejs/webpack-merge#mergewithcustomize-customizearray-customizeobject-configuration--configuration)
+* The image widget now accepts a `placeholderImage` option that works like `previewImage` (just specify a file extension, like `placeholderImage: 'jpg'`, and provide the file `public/placeholder.jpg` in the module). The `placeholderUrl` option is still available for backwards compatibility.
+
+### Fixes
+
+* `docId` is now properly passed through array and object fields and into their child schemas.
+* Remove module `@apostrophecms/polymorphic-type` name alias `@apostrophecms/polymorphic`. It was causing warnings
+    e.g. `A permission.can() call was made with a type that has no manager: @apostrophecms/polymorphic-type`.
+* The module `webpack.extensions` configuration is not applied to the core Admin UI build anymore. This is the correct and intended behavior as explained in the [relevant documentation](https://v3.docs.apostrophecms.org/guide/webpack.html#extending-webpack-configuration).
+* The `previewImage` option now works properly for widget modules loaded from npm and those that subclass them. Specifically, the preview image may be provided in the `public/` subdirectory of the original module, the project-level configuration of it, or a subclass.
+ 
+## 3.36.0 (2022-12-22)
+
+### Adds
+
+* `shortcut` option for piece modules, allowing easy re-mapping of the manager command shortcut per module. 
+
+### Fixes 
+
+* Ensure there are no conflicting command shortcuts for the core modules.
 
 ## 3.35.0 (2022-12-21)
 

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

@@ -363,7 +363,7 @@ export default {
         apos.area.activeEditor = this;
         const result = await apos.modal.execute(componentName, {
           value: widget,
-          options: this.options.widgets[widget.type],
+          options: this.widgetOptionsByType(widget.type),
           type: widget.type,
           docId: this.docId
         });

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

@@ -36,8 +36,8 @@
                     class="apos-icon--add"
                   />
                   <img
-                    v-if="item.previewImage"
-                    :src="previewUrl(item)"
+                    v-if="item.previewUrl"
+                    :src="item.previewUrl"
                     :alt="`${item.name} preview`"
                     class="apos-widget__preview-image"
                   >
@@ -176,9 +176,6 @@ export default {
     hasIcon(widget) {
       return widget.previewIcon || widget.icon;
     },
-    previewUrl(widget) {
-      return widget.previewImage ? apos.util.assetUrl(`/modules/${widget.name}-widget/preview.${widget.previewImage}`) : '';
-    },
     close() {
       this.modal.showModal = false;
     },

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

@@ -7,7 +7,7 @@ const path = require('path');
 const util = require('util');
 const express = require('express');
 const { stripIndent } = require('common-tags');
-const { merge: webpackMerge } = require('webpack-merge');
+const { mergeWithCustomize: webpackMerge } = require('webpack-merge');
 const cuid = require('cuid');
 const chokidar = require('chokidar');
 const _ = require('lodash');
@@ -73,7 +73,6 @@ module.exports = {
     self.buildWatcherEnable = process.env.APOS_ASSET_WATCH !== '0' && self.options.watch !== false;
     self.buildWatcherDebounceMs = parseInt(self.options.watchDebounceMs || 1000, 10);
     self.buildWatcher = null;
-
   },
   handlers (self) {
     return {
@@ -389,8 +388,11 @@ module.exports = {
                 es5TaskFn: self.es5TaskFn
               }, self.apos);
 
-              const webpackInstanceConfigMerged = self.webpackExtensions
-                ? webpackMerge(webpackInstanceConfig, ...Object.values(self.webpackExtensions))
+              const webpackInstanceConfigMerged = !options.apos && self.webpackExtensions
+                ? webpackMerge({
+                  customizeArray: self.srcCustomizeArray,
+                  customizeObject: self.srcCustomizeObject
+                })(webpackInstanceConfig, ...Object.values(self.webpackExtensions))
                 : webpackInstanceConfig;
 
               // Inject the cache location at the end - we need the merged config
@@ -941,6 +943,28 @@ module.exports = {
       // Open the implementation for more dev comments.
       transformRebundledFor,
 
+      // Optional functions passed to webpack's mergeWithCustomize, allowing
+      // fine control over merging of the webpack configuration for the
+      // src build. Extend or override to alter the default behavior.
+      // See https://github.com/survivejs/webpack-merge#mergewithcustomize-customizearray-customizeobject-configuration--configuration
+      srcCustomizeArray(a, b, key) {
+        // Keep arrays unique when merging
+        if (
+          [
+            'resolveLoader.extensions',
+            'resolveLoader.modules',
+            'resolve.extensions',
+            'resolve.modules'
+          ].includes(key)
+        ) {
+          return _.uniq([ ...a, ...b ]);
+        }
+      },
+
+      srcCustomizeObject(a, b, key) {
+        // override to alter the default webpack merge behavior
+      },
+
       async initUploadfs() {
         if (self.options.uploadfs) {
           self.uploadfs = await self.apos.modules['@apostrophecms/uploadfs'].getInstance(self.options.uploadfs);
@@ -1319,6 +1343,11 @@ module.exports = {
           return 'url(\'' + filter(url) + '\')';
         });
         return css;
+      },
+      // Return the URL of the asset with the given path, taking into account
+      // the release id, uploadfs, etc.
+      url(path) {
+        return `${self.getAssetBaseUrl()}${path}`;
       }
     };
   },
@@ -1336,8 +1365,10 @@ module.exports = {
         }
         return self.apos.template.safe(`<script data-apos-refresh-on-restart="${self.action}/restart-id" src="${self.action}/refresh-on-restart"></script>`);
       },
+      // Return the URL of the release asset with the given path, taking into account
+      // the release id, uploadfs, etc.
       url(path) {
-        return `${self.getAssetBaseUrl()}${path}`;
+        return self.url(path);
       }
     };
   },

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

@@ -1096,8 +1096,9 @@ module.exports = {
       normalizeType(type) {
         if (type === '@apostrophecms/page') {
           // Backwards compatible
-          type = '@apostrophecms/any-page-type';
+          return '@apostrophecms/any-page-type';
         }
+
         return type;
       },
       // Given a doc, an _id, or an aposDocId, this method

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

@@ -98,7 +98,7 @@ module.exports = {
             action: 'edit',
             type: self.__meta.name
           },
-          shortcut: `G,${self.apos.task.getReq().t(self.options.label).slice(0, 1)}`
+          shortcut: self.options.shortcut ?? `G,${self.apos.task.getReq().t(self.options.label).slice(0, 1)}`
         },
         [`${self.__meta.name}:create-new`]: {
           type: 'item',

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

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

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

@@ -6,7 +6,8 @@ module.exports = {
     quickCreate: false,
     autopublish: true,
     editRole: 'editor',
-    publishRole: 'editor'
+    publishRole: 'editor',
+    shortcut: 'G,o'
   },
   fields: {
     remove: [ 'visibility' ]

package/modules/@apostrophecms/image-widget/index.js

@@ -7,7 +7,7 @@ module.exports = {
     dimensionAttrs: false,
     placeholder: true,
     placeholderClass: false,
-    placeholderUrl: '/modules/@apostrophecms/image-widget/placeholder.jpg'
+    placeholderImage: 'jpg'
   },
   fields: {
     add: {
@@ -19,5 +19,8 @@ module.exports = {
         withType: '@apostrophecms/image'
       }
     }
+  },
+  init(self) {
+    self.determineBestAssetUrl('placeholder');
   }
 };

package/modules/@apostrophecms/image-widget/views/widget.html

@@ -1,6 +1,6 @@
 {% if data.widget.aposPlaceholder and data.manager.options.placeholderUrl %}
   <img
-    src="{{ apos.asset.url(data.manager.options.placeholderUrl) }}"
+    src="{{ data.manager.options.placeholderUrl }}"
     alt="{{ __t('apostrophe:imagePlaceholder') }}"
     class="image-widget-placeholder"
   />

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

@@ -27,6 +27,7 @@
 
 const { SemanticAttributes } = require('@opentelemetry/semantic-conventions');
 const _ = require('lodash');
+const fs = require('fs');
 
 module.exports = {
 
@@ -761,6 +762,46 @@ module.exports = {
         );
       },
 
+      // Given a name such as "placeholder", look at the
+      // relevant options (nameImage and, as a fallback, nameUrl)
+      // and determine the appropriate asset URL. If nameImage is used,
+      // search the inheritance chain of the module
+      // for the best match, e.g. a file in a project-level override
+      // wins, followed by the original module in core or npm,
+      // followed by something in a base class that extends, etc.
+      // If no file is found, the method returns `undefined`.
+      //
+      // Even if `nameUrl is used, the method still corrects paths
+      // beginning with `/module` to account for the actual asset
+      // release URL (`nameUrl` is really an asset path, but for bc
+      // this is the naming pattern).
+      //
+      // In the above examples "name" should be replaced with the
+      // actual value of the name argument.
+
+      determineBestAssetUrl(name) {
+        let urlOption = self.options[`${name}Url`];
+        const imageOption = self.options[`${name}Image`];
+        if (!urlOption) {
+          if (imageOption) {
+            const chain = [ ...self.__meta.chain ].reverse();
+            for (const entry of chain) {
+              const path = `${entry.dirname}/public/${name}.${imageOption}`;
+              if (fs.existsSync(path)) {
+                urlOption = `/modules/${entry.name}/${name}.${imageOption}`;
+                break;
+              }
+            }
+          }
+        }
+        if (urlOption && urlOption.startsWith('/modules')) {
+          urlOption = self.apos.asset.url(urlOption);
+        }
+        if (urlOption) {
+          self.options[`${name}Url`] = urlOption;
+        }
+      },
+
       // Merge in the event emitter / responder capabilities
       ...require('./lib/events.js')(self)
     };

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

@@ -1,11 +1,20 @@
 const _ = require('lodash');
+const migrations = require('./lib/migrations.js');
 
 module.exports = {
   extend: '@apostrophecms/doc-type',
   options: {
-    name: '@apostrophecms/polymorphic',
+    name: '@apostrophecms/polymorphic-type',
     showPermissions: false
   },
+  init(self) {
+    self.addMigrations();
+  },
+  methods(self) {
+    return {
+      ...migrations(self)
+    };
+  },
   routes(self) {
     return {
       post: {

package/modules/@apostrophecms/polymorphic-type/lib/migrations.js

@@ -0,0 +1,18 @@
+module.exports = (self) => {
+  return {
+    addMigrations() {
+      self.removePolymorphicTypeAliasMigration();
+    },
+    removePolymorphicTypeAliasMigration() {
+      self.apos.migration.add('remove-polymorphic-type-alias', () => {
+        return self.apos.doc.db.updateMany({
+          type: '@apostrophecms/polymorphic'
+        }, {
+          $set: {
+            type: '@apostrophecms/polymorphic-type'
+          }
+        });
+      });
+    }
+  };
+};

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

@@ -1474,8 +1474,9 @@ module.exports = {
     return {
       get: {
         async choices(req) {
-          const id = self.apos.launder.string(req.query.fieldId);
-          const field = self.getFieldById(id);
+          const fieldId = self.apos.launder.string(req.query.fieldId);
+          const docId = self.apos.launder.string(req.query.docId);
+          const field = self.getFieldById(fieldId);
           let choices = [];
           if (
             !field ||
@@ -1484,7 +1485,7 @@ module.exports = {
           ) {
             throw self.apos.error('invalid');
           }
-          choices = await self.apos.modules[field.moduleName][field.choices](req);
+          choices = await self.apos.modules[field.moduleName][field.choices](req, { docId });
           if (Array.isArray(choices)) {
             return {
               choices

package/modules/@apostrophecms/schema/ui/apos/components/AposArrayEditor.vue

@@ -72,6 +72,7 @@
                     @validate="triggerValidate"
                     :server-errors="currentDocServerErrors"
                     ref="schema"
+                    :doc-id="docId"
                   />
                 </div>
               </div>
@@ -109,6 +110,10 @@ export default {
     serverError: {
       type: Object,
       default: null
+    },
+    docId: {
+      type: String,
+      default: null
     }
   },
   emits: [ 'modal-result', 'safe-close' ],

package/modules/@apostrophecms/schema/ui/apos/components/AposInputArray.vue

@@ -64,6 +64,7 @@
                     :utility-rail="false"
                     :generation="generation"
                     :modifiers="['small', 'inverted']"
+                    :doc-id="docId"
                   />
                 </div>
               </transition>
@@ -214,7 +215,8 @@ export default {
       const result = await apos.modal.execute('AposArrayEditor', {
         field: this.field,
         items: this.next,
-        serverError: this.serverError
+        serverError: this.serverError,
+        docId: this.docId
       });
       if (result) {
         this.next = result;

package/modules/@apostrophecms/schema/ui/apos/components/AposInputObject.vue

@@ -15,6 +15,7 @@
             :trigger-validation="triggerValidation"
             :utility-rail="false"
             :generation="generation"
+            :doc-id="docId"
             v-model="schemaInput"
             ref="schema"
           />
@@ -37,6 +38,13 @@ export default {
       default() {
         return null;
       }
+    },
+    docId: {
+      type: String,
+      required: false,
+      default() {
+        return null;
+      }
     }
   },
   data () {

package/modules/@apostrophecms/schema/ui/apos/mixins/AposInputChoicesMixin.js

@@ -17,7 +17,8 @@ export default {
         `${action}/choices`,
         {
           qs: {
-            fieldId: this.field._id
+            fieldId: this.field._id,
+            docId: this.docId
           },
           busy: true
         }

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

@@ -106,6 +106,8 @@ module.exports = {
 
     self.enableBrowserData();
 
+    self.determineBestAssetUrl('preview');
+
     self.template = self.options.template || 'widget';
 
     self.name = self.__meta.name.replace(/-widget$/, '');
@@ -362,6 +364,7 @@ module.exports = {
           version. The method in 3.x simply returns an empty array.`);
         return [];
       }
+
     };
   },
   extendMethods(self) {
@@ -384,7 +387,7 @@ module.exports = {
           description: self.options.description,
           icon: self.options.icon,
           previewIcon: self.options.previewIcon,
-          previewImage: self.options.previewImage,
+          previewUrl: self.options.previewUrl,
           action: self.action,
           schema: schema,
           contextual: self.options.contextual,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apostrophe",
-  "version": "3.35.0",
+  "version": "3.37.0",
   "description": "The Apostrophe Content Management System.",
   "main": "index.js",
   "scripts": {

package/test/widgets.js

@@ -290,7 +290,6 @@ describe('Widgets', function() {
         },
         assertFalsyPlaceholderUrl(document) {
           const imgNodes = document.querySelectorAll('img');
-
           assert(imgNodes.length === 0);
         },
         assertPlaceholderUrlOverride(document) {
@@ -409,7 +408,8 @@ describe('Widgets', function() {
                 'placeholder-page': {},
                 [`@apostrophecms/${type}-widget`]: {
                   options: {
-                    placeholderUrl: null
+                    placeholderUrl: null,
+                    placeholderImage: null
                   }
                 }
               }