apostrophe 3.4.1 → 3.8.0

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

@@ -259,20 +259,32 @@ export default {
       // So that areas revert to being editable
       await this.refresh();
     },
-    async onContextEditing() {
-      // Accept a hint that someone is actively typing in a
-      // rich text editor and a context-edited event is likely
-      // coming; allows continuity of the "Saving..." indicator
-      // so it doesn't flicker once a second as you type
-      this.editing = true;
-      if (this.editingTimeout) {
-        clearTimeout(this.editingTimeout);
+    // Accept a hint that a user is actively typing and/or manipulating controls
+    // and it would best not to enable a save button or a "...Saved" indication yet
+    // to avoid a frenetic display and/or a situation where not everything is ready
+    // to be saved yet.
+    //
+    // If the event is emitted with a boolean value of `true`, the emitter takes
+    // responsibility for later emitting `false` to indicate active typing/manipulating
+    // is no longer in progress. If the event is emitted with no value then there is a
+    // 1100-millisecond, debounced timeout.
+
+    async onContextEditing(state) {
+      if ((typeof state) === 'boolean') {
+        this.editing = state;
+      } else {
+        if (!this.editing) {
+          this.editing = true;
+        }
+        if (this.editingTimeout) {
+          clearTimeout(this.editingTimeout);
+        }
+        this.editingTimeout = setTimeout(() => {
+          this.editing = false;
+          // Wait slightly longer than the rich text editor does
+          // before sending us a context-edited event
+        }, 1100);
       }
-      this.editingTimeout = setTimeout(() => {
-        this.editing = false;
-        // Wait slightly longer than the rich text editor does
-        // before sending us a context-edited event
-      }, 1100);
     },
     async onPublish(e) {
       if (!this.canPublish) {
@@ -451,7 +463,11 @@ export default {
       }
     },
     async onContentChanged(e) {
-      if (e.doc && (e.doc._id === this.context._id)) {
+
+      if (
+        (e.doc && (e.doc._id === this.context._id)) ||
+        (e.docIds && e.docIds.includes(this.context._id))
+      ) {
         if (e.action === 'delete') {
           if (!this.contextStack.length) {
             // With the current page gone, we need to move to safe ground

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

@@ -1,5 +1,6 @@
 const _ = require('lodash');
 const deep = require('deep-get-set');
+const { stripIndent } = require('common-tags');
 
 // An area is a series of zero or more widgets, in which users can add
 // and remove widgets and drag them to reorder them. This module implements
@@ -131,6 +132,14 @@ module.exports = {
         const field = self.apos.schema.getFieldById(area._fieldId);
 
         const options = field.options;
+        if (!options) {
+          throw new Error(stripIndent`
+            The area field ${field.name} has no options property.
+
+            You probably forgot to nest the widgets property
+            in an options property.
+          `);
+        }
         _.each(options.widgets, function (options, name) {
           const manager = self.widgetManagers[name];
           if (manager) {

package/modules/@apostrophecms/area/lib/custom-tags/area.js

@@ -46,7 +46,7 @@ module.exports = function(self) {
       return { args };
     },
     async run(context, doc, name, _with) {
-      const req = context.env.opts.req;
+      const req = context.ctx.__req;
       let area;
       if ((!doc) || ((typeof doc) !== 'object')) {
         throw usage('You must pass an existing doc or widget as the first argument.');

package/modules/@apostrophecms/area/lib/custom-tags/widget.js

@@ -40,7 +40,7 @@ module.exports = function(self) {
       return { args };
     },
     async run(context, item, options, _with) {
-      const req = context.env.opts.req;
+      const req = context.ctx.__req;
       if (!item) {
         self.apos.util.warn('a null widget was encountered.');
         return '';

package/modules/@apostrophecms/area/ui/apos/apps/AposAreas.js

@@ -6,6 +6,9 @@ export default function() {
   createWidgetClipboardApp();
 
   prepareAreas();
+
+  document.documentElement.style.setProperty('--a-widget-margin', apos.ui.widgetMargin);
+
   apos.bus.$on('widget-rendered', function() {
     prepareAreas();
   });

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

@@ -384,9 +384,9 @@ export default {
       }
       if (!this.focused) {
         this.state.labels.show = false;
+        this.state.add.top.show = false;
+        this.state.add.bottom.show = false;
       }
-      this.state.add.top.show = false;
-      this.state.add.bottom.show = false;
     },
 
     focus(e) {
@@ -396,8 +396,8 @@ export default {
       this.focused = true;
       this.state.container.focus = true;
       this.state.controls.show = true;
-      this.state.add.top.show = false;
-      this.state.add.bottom.show = false;
+      this.state.add.top.show = true;
+      this.state.add.bottom.show = true;
       this.state.labels.show = true;
       document.addEventListener('click', this.unfocus);
     },
@@ -615,8 +615,8 @@ export default {
   }
 
   .apos-area-widget-wrapper--foreign .apos-area-widget-inner .apos-area-widget__breadcrumbs {
-    background-color: var(--a-primary);
-    & ::v-deep .apos-button {
+    background-color: var(--a-background-inverted);
+    & ::v-deep .apos-button__content {
       color: var(--a-text-inverted);
     }
   }

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

@@ -73,6 +73,12 @@ module.exports = {
           await fs.remove(buildDir);
           await fs.mkdirp(buildDir);
 
+          // Static asset files in `public` subdirs of each module are copied
+          // to the same relative path `/public/apos-frontend/namespace/modules/modulename`.
+          // Inherited files are also copied, with the deepest subclass overriding in the
+          // event of a conflict
+          await moduleOverrides(`${bundleDir}/modules`, 'public');
+
           for (const [ name, options ] of Object.entries(self.builds)) {
             // If the option is not present always rebuild everything
             let rebuild = argv && !argv['check-apos-build'];
@@ -122,12 +128,17 @@ module.exports = {
           // just `public` and `apos`) by examining those specified as
           // targets for the various builds
           const scenes = [ ...new Set(Object.values(self.builds).map(options => options.scenes).flat()) ];
-          let bundles = [];
+          let deployFiles = [];
           for (const scene of scenes) {
-            bundles = [ ...bundles, ...merge(scene) ];
+            deployFiles = [ ...deployFiles, ...merge(scene) ];
           }
-
-          await deploy(bundles);
+          // enumerate public assets and include them in deployment if appropriate
+          const publicAssets = glob.sync('modules/**/*', {
+            cwd: bundleDir,
+            mark: true
+          }).filter(match => !match.endsWith('/'));
+          deployFiles = [ ...deployFiles, ...publicAssets ];
+          await deploy(deployFiles);
 
           if (process.env.APOS_BUNDLE_ANALYZER) {
             return new Promise((resolve, reject) => {
@@ -162,7 +173,7 @@ module.exports = {
             for (const name of names) {
               const moduleDir = `${modulesDir}/${name}`;
               for (const dir of directories[name]) {
-                const srcDir = `${dir}/ui/${source}`;
+                const srcDir = `${dir}/${source}`;
                 if (fs.existsSync(srcDir)) {
                   await fs.copy(srcDir, moduleDir);
                 }
@@ -176,7 +187,7 @@ module.exports = {
             }));
             const modulesDir = `${buildDir}/${name}/modules`;
             const source = options.source || name;
-            await moduleOverrides(modulesDir, source);
+            await moduleOverrides(modulesDir, `ui/${source}`);
 
             let iconImports, componentImports, tiptapExtensionImports, appImports, indexJsImports, indexSassImports;
             if (options.apos) {
@@ -233,7 +244,8 @@ module.exports = {
               // Remove previous build artifacts, as some pipelines won't build all artifacts
               // if there is no input, and we don't want stale output in the bundle
               fs.removeSync(`${bundleDir}/${outputFilename}`);
-              fs.removeSync(`${bundleDir}/${outputFilename}`.replace(/\.js$/, '.css'));
+              const cssPath = `${bundleDir}/${outputFilename}`.replace(/\.js$/, '.css');
+              fs.removeSync(cssPath);
               await Promise.promisify(webpackModule)(require(`./lib/webpack/${name}/webpack.config`)(
                 {
                   importFile,
@@ -243,6 +255,11 @@ module.exports = {
                 },
                 self.apos
               ));
+              if (fs.existsSync(cssPath)) {
+                fs.writeFileSync(cssPath, self.filterCss(fs.readFileSync(cssPath, 'utf8'), {
+                  modulesPrefix: `${self.getAssetBaseUrl()}/modules`
+                }));
+              }
               if (options.apos) {
                 const now = Date.now().toString();
                 fs.writeFileSync(`${bundleDir}/${name}-build-timestamp.txt`, now);
@@ -269,7 +286,9 @@ module.exports = {
                 const publicImports = getImports(name, '*.css', { });
                 fs.writeFileSync(`${bundleDir}/${name}-build.css`,
                   publicImports.paths.map(path => {
-                    return fs.readFileSync(path, 'utf8');
+                    return self.filterCss(fs.readFileSync(path, 'utf8'), {
+                      modulesPrefix: `${self.getAssetBaseUrl()}/modules`
+                    });
                   }).join('\n')
                 );
               }
@@ -358,7 +377,19 @@ module.exports = {
             return [ jsModules, jsNoModules, css ];
           }
 
-          async function deploy(bundles) {
+          // If NODE_ENV is production, this function will copy the given
+          // array of asset files from `${bundleDir}/${file}` to
+          // the same relative location in the appropriate release subdirectory in
+          // `/public/apos-frontend/releases`, or in `/apos-frontend/releases` in
+          // uploadfs if `APOS_UPLOADFS_ASSETS` is present.
+          //
+          // If NODE_ENV is not production this function does nothing and
+          // the assets are served directly from `/public/apos-frontend/${file}`.
+          //
+          // The namespace (e.g. default) should be part of each filename given.
+          // A leading slash should NOT be passed.
+
+          async function deploy(files) {
             if (process.env.NODE_ENV !== 'production') {
               return;
             }
@@ -373,17 +404,23 @@ module.exports = {
             } else {
               // The right choice with Docker if uploadfs is just the local filesystem
               // mapped to a volume (a Docker build step can't access that)
-              copyIn = fs.copyFile;
+              copyIn = fsCopyIn;
               releaseDir = `${self.apos.rootDir}/public/apos-frontend/releases/${releaseId}/${namespace}`;
               await fs.mkdirp(releaseDir);
             }
-            for (const bundle of bundles) {
-              const src = `${bundleDir}/${bundle}`;
-              await copyIn(src, `${releaseDir}/${bundle}`);
+            for (const file of files) {
+              const src = `${bundleDir}/${file}`;
+              await copyIn(src, `${releaseDir}/${file}`);
               await fs.remove(src);
             }
           }
 
+          async function fsCopyIn(from, to) {
+            const base = path.dirname(to);
+            await fs.mkdirp(base);
+            return fs.copyFile(from, to);
+          }
+
           function getImports(folder, pattern, options) {
             let components = [];
             const seen = {};
@@ -580,7 +617,14 @@ module.exports = {
             if (data) {
               document.body.removeAttribute('data-apos');
             }
-          })();
+            if (window.apos.modules) {
+              for (const module of Object.values(window.apos.modules)) {
+                if (module.alias) {
+                  window.apos[module.alias] = module;
+                }
+              }
+            }
+        })();
         `;
         self.builds = {
           src: {
@@ -632,13 +676,6 @@ module.exports = {
             prologue: stripIndent`
               import 'Modules/@apostrophecms/ui/scss/global/import-all.scss';
               import Vue from 'Modules/@apostrophecms/ui/lib/vue';
-              if (window.apos.modules) {
-                for (const module of Object.values(window.apos.modules)) {
-                  if (module.alias) {
-                    window.apos[module.alias] = module;
-                  }
-                }
-              }
               window.apos.bus = new Vue();
             `,
             // Load only in browsers that support ES6 modules
@@ -650,6 +687,30 @@ module.exports = {
         if (!self.options.es5) {
           delete self.builds['src-es5'];
         }
+      },
+      // Filter the given css performing any necessary transformations,
+      // such as support for the /modules path regardless of where
+      // static assets are actually deployed
+      filterCss(css, { modulesPrefix }) {
+        return self.filterCssUrls(css, url => {
+          if (url.startsWith('/modules')) {
+            return url.replace('/modules', modulesPrefix);
+          }
+          return url;
+        });
+      },
+      // Run all URLs in CSS through a filter function
+      filterCssUrls(css, filter) {
+        css = css.replace(/url\(([^'"].*?)\)/g, function(s, url) {
+          return 'url(' + filter(url) + ')';
+        });
+        css = css.replace(/url\("([^"]+?)"\)/g, function(s, url) {
+          return 'url("' + filter(url) + '")';
+        });
+        css = css.replace(/url\('([^']+?)'\)/g, function(s, url) {
+          return 'url(\'' + filter(url) + '\')';
+        });
+        return css;
       }
     };
   },
@@ -667,6 +728,9 @@ module.exports = {
         }
         const script = fs.readFileSync(path.join(__dirname, '/lib/refresh-on-restart.js'), 'utf8');
         return self.apos.template.safe(`<script data-apos-refresh-on-restart="${self.action}/restart-id">\n${script}</script>`);
+      },
+      url(path) {
+        return `${self.getAssetBaseUrl()}${path}`;
       }
     };
   },

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

@@ -56,9 +56,11 @@ module.exports = {
   'play-box-icon': 'PlayBox',
   'instagram-icon': 'Instagram',
   'label-icon': 'Label',
+  'lightbulb-on-icon': 'LightbulbOn',
   'link-icon': 'Link',
   'list-status-icon': 'ListStatus',
   'lock-icon': 'Lock',
+  'map-marker-icon': 'MapMarker',
   'magnify-icon': 'Magnify',
   'menu-down-icon': 'MenuDown',
   'minus-icon': 'Minus',

package/modules/@apostrophecms/asset/lib/webpack/src/webpack.scss.js

@@ -9,8 +9,11 @@ module.exports = (options, apos) => {
           use: [
             // Instead of style-loader, to avoid FOUC
             MiniCssExtractPlugin.loader,
-            // Parses CSS imports
-            'css-loader',
+            // Parses CSS imports and make css-loader ignore urls. Urls will still be handled by webpack
+            {
+              loader: 'css-loader',
+              options: { url: false }
+            },
             // Provides autoprefixing
             {
               loader: 'postcss-loader',

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

@@ -1038,6 +1038,7 @@ module.exports = {
           action: self.action,
           fileGroups: self.fileGroups,
           name: self.name,
+          // for bc
           uploadsUrl: self.uploadfs.getUrl(),
           croppable: self.croppable,
           sized: self.sized

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

@@ -1,4 +1,4 @@
-// This module establishes `apos.db`, the mongodb driver connection object.
+// This module establishes `apos.db`, the MongoDB database object.
 //
 // ## Options
 //
@@ -20,8 +20,7 @@
 //
 // ### `client`
 //
-// An existing MongoDB connection (MongoClient) object. If present, a new
-// connection instance is created that reuses the same sockets,
+// An existing MongoDB connection (MongoClient) object. If present, it is used
 // and `uri`, `host`, `connect`, etc. are ignored.
 //
 // ### `versionCheck`
@@ -40,7 +39,7 @@
 // allow other modules to drop related non-MongoDB resources at the
 // same time, if desired.
 //
-// Note that `apos.db` is the mongodb database object, not this module.
+// Note that `apos.db` is the MongoDB database object, not this module.
 // You shouldn't need to talk to this module after startup, but you can
 // access it as `apos.modules['@apostrophecms/db']` if you wish. You can
 // also access `apos.dbClient` if you need the MongoClient object.
@@ -81,8 +80,8 @@ module.exports = {
   },
   methods(self) {
     return {
-      // Open the database connection. Always use MongoClient with its
-      // sensible defaults. Build a URI if we need to, so we can call it
+      // Open the database connection. Always uses MongoClient with its
+      // sensible defaults. Builds a URI if necessary, so we can call it
       // in a consistent way.
       //
       // One default we override: if the connection is lost, we keep

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

@@ -38,11 +38,19 @@ module.exports = {
   restApiRoutes(self) {
     return {
       // GET /api/v1/@apostrophecms/doc/_id supports only the universal query
-      // features, but works for any document type, Simplifies browser-side
-      // logic for redirects to foreign documents; the frontend only has to
+      // features, but works for any document type. Simplifies browser-side
+      // logic for redirects to foreign documents. The frontend only has to
       // know the doc _id.
+      //
+      // Since this API is solely for editing purposes you will receive
+      // a 404 if you request a document you cannot edit.
       async getOne(req, _id) {
-        return self.find(req, { _id }).toObject();
+        _id = self.apos.i18n.inferIdLocaleAndMode(req, _id);
+        const doc = await self.find(req, { _id }).permission('edit').toObject();
+        if (!doc) {
+          throw self.apos.error('notfound');
+        }
+        return doc;
       }
     };
   },
@@ -431,6 +439,7 @@ module.exports = {
         await self.insertBody(req, doc, options);
         await m.emit('afterInsert', req, doc, options);
         await m.emit('afterSave', req, doc, options);
+        // TODO: Remove `afterLoad` in next major version. Deprecated.
         await m.emit('afterLoad', req, [ doc ]);
         return doc;
       },
@@ -466,6 +475,7 @@ module.exports = {
         await self.updateBody(req, doc, options);
         await m.emit('afterUpdate', req, doc, options);
         await m.emit('afterSave', req, doc, options);
+        // TODO: Remove `afterLoad` in next major version. Deprecated.
         await m.emit('afterLoad', req, [ doc ]);
         return doc;
       },

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

@@ -389,7 +389,7 @@ module.exports = {
         self.schema = self.apos.schema.compose({
           addFields: self.apos.schema.fieldsToArray(`Module ${self.__meta.name}`, self.fields),
           arrangeFields: self.apos.schema.groupsToArray(self.fieldsGroups)
-        });
+        }, self);
         if (self.options.slugPrefix) {
           if (self.options.slugPrefix === 'deduplicate-') {
             const req = self.apos.task.getReq();
@@ -738,7 +738,7 @@ module.exports = {
       },
       // Localize (export) the given draft to another locale, creating the document in the
       // other locale if necessary. By default, if the document already exists in the
-      // other locale, it is not ovewritten. Use the `update: true` option to change that.
+      // other locale, it is not overwritten. Use the `update: true` option to change that.
       // You can localize starting from either draft or published content. Either way what
       // gets created or updated in the other locale is a draft.
       async localize(req, draft, toLocale, options = { update: false }) {
@@ -1217,6 +1217,21 @@ module.exports = {
         // cursors.
 
         project: {
+          launder (p) {
+            // check that project is an object
+            if (!p || typeof p !== 'object' || Array.isArray(p)) {
+              return {};
+            }
+
+            const projection = Object.entries(p).reduce((acc, [ key, val ]) => {
+              return {
+                ...acc,
+                [key]: self.apos.launder.boolean(val)
+              };
+            }, {});
+
+            return projection;
+          },
           finalize() {
             let projection = query.get('project') || {};
             // Keys beginning with `_` are computed values
@@ -1442,9 +1457,14 @@ module.exports = {
         attachments: {
           def: false,
           after(results) {
-            for (const doc of results) {
-              self.apos.attachment.all(doc, { annotate: true });
+            const attachments = query.get('attachments');
+
+            if (attachments) {
+              self.apos.attachment.all(results, { annotate: true });
             }
+          },
+          launder(b) {
+            return self.apos.launder.boolean(b);
           }
         },
 

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

@@ -286,9 +286,21 @@ export default {
     apos.bus.$off('content-changed', this.onContentChanged);
   },
   methods: {
-    onContentChanged(e) {
+    async onContentChanged(e) {
       if (e.doc && (e.doc._id === this.context._id)) {
         this.context = e.doc;
+      } else if (e.docIds && e.docIds.includes(this.context._id)) {
+        try {
+          this.context = await apos.http.get(`${this.moduleOptions.action}/${this.context._id}`, {
+            busy: true
+          });
+        } catch (error) {
+          // If not found it is likely that there was an archiving or restoring
+          // batch operation.
+          if (error.name !== 'notfound') {
+            console.error(error);
+          }
+        }
       }
     },
     menuHandler(action) {

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

@@ -68,6 +68,7 @@
               :doc-id="docId"
               :value="docFields"
               @input="updateDocFields"
+              @validate="triggerValidate"
               :server-errors="serverErrors"
               :ref="tab.name"
             />
@@ -90,6 +91,7 @@
             :doc-id="docId"
             :value="docFields"
             @input="updateDocFields"
+            @validate="triggerValidate"
             :modifiers="['small', 'inverted']"
             ref="utilitySchema"
             :server-errors="serverErrors"
@@ -444,6 +446,7 @@ export default {
         if (!this.errorCount) {
           this[action]();
         } else {
+          this.triggerValidation = false;
           await apos.notify('apostrophe:resolveErrorsBeforeSaving', {
             type: 'warning',
             icon: 'alert-circle-icon',