apostrophe 3.8.1 → 3.11.0

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

@@ -44,6 +44,7 @@
 // are edge cases not relevant enough to explicitly offer a filter for, but
 // which should nevertheless be included in results.
 
+const { stripIndent } = require('common-tags');
 const _ = require('lodash');
 
 module.exports = {
@@ -98,37 +99,7 @@ module.exports = {
       },
       '@apostrophecms/doc-type:beforeSave': {
         indexDoc(req, doc) {
-
-          const texts = self.getSearchTexts(doc);
-
-          _.each(texts, function (text) {
-            if (text.text === undefined) {
-              text.text = '';
-            }
-          });
-
-          const highTexts = _.filter(texts, function (text) {
-            return text.weight > 10;
-          });
-
-          const searchSummary = _.map(_.filter(texts, function (text) {
-            return !text.silent;
-          }), function (text) {
-            return text.text;
-          }).join(' ');
-          const highText = self.boilTexts(highTexts);
-          const lowText = self.boilTexts(texts);
-          const titleSortified = self.apos.util.sortify(doc.title);
-          const highWords = _.uniq(highText.split(/ /));
-
-          // merge our doc with its various search texts
-          _.assign(doc, {
-            titleSortified: titleSortified,
-            highSearchText: highText,
-            highSearchWords: highWords,
-            lowSearchText: lowText,
-            searchSummary: searchSummary
-          });
+          self.indexDoc(req, doc);
         }
       }
     };
@@ -261,13 +232,58 @@ module.exports = {
         self.dispatch('/', self.indexPage);
       },
 
+      indexDoc(req, doc) {
+
+        const texts = self.getSearchTexts(doc);
+
+        _.each(texts, function (text) {
+          if (text.text === undefined) {
+            text.text = '';
+          }
+        });
+
+        const highTexts = _.filter(texts, function (text) {
+          return text.weight > 10;
+        });
+
+        const searchSummary = _.map(_.filter(texts, function (text) {
+          return !text.silent;
+        }), function (text) {
+          return text.text;
+        }).join(' ');
+        const highText = self.boilTexts(highTexts);
+        const lowText = self.boilTexts(texts);
+        const titleSortified = self.apos.util.sortify(doc.title);
+        const highWords = _.uniq(highText.split(/ /));
+
+        // merge our doc with its various search texts
+        _.assign(doc, {
+          titleSortified: titleSortified,
+          highSearchText: highText,
+          highSearchWords: highWords,
+          lowSearchText: lowText,
+          searchSummary: searchSummary
+        });
+      },
+
       // Indexes just one document as part of the implementation of the
       // `@apostrophecms/search:index` task. This isn't the method you want to
       // override. See `indexDoc` and `getSearchTexts`
 
       async indexTaskOne(req, doc) {
         self.indexDoc(req, doc);
-        return self.apos.doc.db.updateOne({ _id: doc._id }, doc);
+
+        return self.apos.doc.db.updateOne({
+          _id: doc._id
+        }, {
+          $set: {
+            titleSortified: doc.titleSortified,
+            highSearchText: doc.highSearchText,
+            highSearchWords: doc.highSearchWords,
+            lowSearchText: doc.lowSearchText,
+            searchSummary: doc.searchSummary
+          }
+        });
       },
 
       // Returns texts which are a reasonable basis for
@@ -348,7 +364,11 @@ module.exports = {
   tasks(self) {
     return {
       index: {
-        usage: 'Rebuild the search index. Normally this happens automatically.\nThis should only be needed if you have changed the\n"searchable" property for various fields or types.',
+        usage: stripIndent`
+          Rebuild the search index. Normally this happens automatically.
+          This should only be needed if you have changed the"searchable" property
+          for various fields or types.
+        `,
         task(argv) {
           const req = self.apos.task.getReq();
           return self.apos.migration.eachDoc({}, _.partial(self.indexTaskOne, req));

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

@@ -190,7 +190,11 @@ module.exports = {
               role: options.role
             }
           }),
-          res: {},
+          res: {
+            redirect(url) {
+              req.res.redirectedTo = url;
+            }
+          },
           t(key, options = {}) {
             return self.apos.i18n.i18next.t(key, {
               ...options,

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

@@ -1,5 +1,5 @@
 // Implements template rendering via Nunjucks. **You should use the
-// `self.render` and `self.partial` methods of *your own* module**,
+// `self.render` method of *your own* module**,
 // which exist courtesy of [@apostrophecms/module](../@apostrophecms/module/index.html)
 // and invoke methods of this module more conveniently for you.
 //
@@ -21,7 +21,7 @@
 // you have a custom version of Nunjucks that is compatible.
 //
 // ### `viewsFolderFallback`: specifies a folder to be checked for templates
-// if they are not found in the module that called `self.render` or `self.partial`
+// if they are not found in the module that called `self.render`
 // or those it extends. This is a handy place for project-wide macro files.
 // Often set to `__dirname + '/views'` in `app.js`.
 
@@ -203,7 +203,7 @@ module.exports = {
 
       async renderForModule(req, name, data, module) {
         if (typeof req !== 'object') {
-          throw new Error('The first argument to module.render must be req. If you are trying to implement a Nunjucks helper function, use module.partial.');
+          throw new Error('The first argument to module.render must be req.');
         }
         return self.renderBody(req, 'file', name, data, module);
       },
@@ -214,7 +214,7 @@ module.exports = {
 
       async renderStringForModule(req, s, data, module) {
         if (typeof req !== 'object') {
-          throw new Error('The first argument to module.render must be req. If you are trying to implement a Nunjucks helper function, use module.partial.');
+          throw new Error('The first argument to module.render must be req.');
         }
         return self.renderBody(req, 'string', s, data, module);
       },
@@ -289,12 +289,6 @@ module.exports = {
 
         args.data = merged;
 
-        // // Allows templates to render other templates in an independent
-        // // nunjucks environment, rather than including them
-        // args.partial = function(name, data) {
-        //   return self.partialForModule(name, data, module);
-        // };
-
         if (req.data) {
           _.defaults(merged, req.data);
         }
@@ -334,7 +328,7 @@ module.exports = {
 
       // Fetch a nunjucks environment in which `include`, `extends`, etc. search
       // the views directories of the specified module and its ancestors.
-      // Typically you will call `self.render` or `self.partial` on your module
+      // Typically you will call `self.render` on your module
       // object rather than calling this directly.
       //
       // `req` is effectively here for bc purposes only. This method

package/modules/@apostrophecms/ui/ui/apos/components/AposMinMaxCount.vue

@@ -61,7 +61,9 @@ export default {
       return maxError;
     },
     countLabel() {
-      return `${this.value.length} Added`;
+      return this.$t('apostrophe:numberAdded', {
+        count: this.value.length
+      });
     },
     // Here in the array editor we use effectiveMin to factor in the
     // required property because there is no other good place to do that,
@@ -69,14 +71,18 @@ export default {
     // representation of "required".
     minLabel() {
       if (this.effectiveMin) {
-        return `Min: ${this.effectiveMin}`;
+        return this.$t('apostrophe:minUi', {
+          number: this.effectiveMin
+        });
       } else {
         return false;
       }
     },
     maxLabel() {
       if ((typeof this.field.max) === 'number') {
-        return `Max: ${this.field.max}`;
+        return this.$t('apostrophe:maxUi', {
+          number: this.field.max
+        });
       } else {
         return false;
       }

package/modules/@apostrophecms/ui/ui/apos/mixins/AposPublishMixin.js

@@ -49,9 +49,10 @@ export default {
         if ((e.name === 'invalid') && e.body && e.body.data && e.body.data.unpublishedAncestors) {
           if (await apos.confirm({
             heading: 'apostrophe:unpublishedParent',
-            description: 'apostrophe:unpublishedParentDescription',
+            description: 'apostrophe:unpublishedParentDescription'
+          }, {
             interpolate: {
-              unpublishedParents: this.$t(e.body.data.unpublishedAncestors.map(page => page.title).join(this.$t('apostrophe:listJoiner')))
+              unpublishedParents: e.body.data.unpublishedAncestors.map(page => page.title).join(this.$t('apostrophe:listJoiner'))
             }
           })) {
             try {

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

@@ -112,6 +112,7 @@
 // you are debugging a change and need to test all of the different ways a widget has
 // been used, or are wondering if you can safely remove one.
 
+const { stripIndent } = require('common-tags');
 const _ = require('lodash');
 
 module.exports = {
@@ -310,12 +311,20 @@ module.exports = {
       },
 
       // override to add CSS classes to the outer wrapper div of the widget.
+      // TODO: Remove in the 4.x major version.
       getWidgetWrapperClasses(widget) {
+        self.apos.util.warnDev(stripIndent`
+          The getWidgetWrapperClasses method is deprecated and will be removed in the next
+          major version. The method in 3.x simply returns an empty array.`);
         return [];
       },
 
       // Override to add CSS classes to the div of the widget itself.
+      // TODO: Remove in the 4.x major version.
       getWidgetClasses(widget) {
+        self.apos.util.warnDev(stripIndent`
+          The getWidgetClasses method is deprecated and will be removed in the next major
+          version. The method in 3.x simply returns an empty array.`);
         return [];
       }
     };

package/modules/@apostrophecms/widget-type/ui/apos/mixins/AposWidgetMixin.js

@@ -22,17 +22,11 @@ export default {
   },
   data() {
     return {
-      rendered: '...',
-      playerOpts: null,
-      playerEl: null
+      rendered: '...'
     };
   },
   mounted() {
     this.renderContent();
-    this.playerOpts = apos.util.widgetPlayers[this.type] || null;
-  },
-  updated () {
-    this.runPlayer();
   },
   computed: {
     moduleOptions() {
@@ -41,7 +35,7 @@ export default {
   },
   methods: {
     async renderContent() {
-      const self = this;
+      apos.bus.$emit('widget-rendering');
       const parameters = {
         _docId: this.docId,
         widget: this.value,
@@ -51,7 +45,6 @@ export default {
       try {
         if (this.rendering && (isEqual(this.rendering.parameters, parameters))) {
           this.rendered = this.rendering.html;
-          this.runPlayer();
         } else {
           this.rendered = '...';
           this.rendered = await apos.http.post(`${apos.area.action}/render-widget?aposEdit=1&aposMode=draft`, {
@@ -59,11 +52,10 @@ export default {
             body: parameters
           });
         }
-        // Wait for reactivity to populate v-html so the
-        // AposAreas manager can spot any new area divs.
-        // This will also run the player
+        // Wait for reactivity to render v-html so that markup is
+        // in the DOM before hinting that it might be time to prepare
+        // sub-area editors and run players
         setTimeout(function() {
-          self.setPlayerEl();
           apos.bus.$emit('widget-rendered');
         }, 0);
       } catch (e) {
@@ -71,20 +63,6 @@ export default {
         console.error('Unable to render widget. Possibly the schema has been changed and the existing widget does not pass validation.', e);
       }
     },
-    setPlayerEl() {
-      if (this.playerOpts) {
-        const el = this.$el.querySelector(this.playerOpts.selector);
-        if (el && this.playerOpts.player) {
-          this.playerEl = el;
-        }
-      }
-    },
-    runPlayer() {
-      if (this.playerEl && !this.playerEl.aposWidgetPlayed) {
-        this.playerOpts.player(this.playerEl);
-        this.playerEl.aposWidgetPlayed = true;
-      }
-    },
     clicked(e) {
       // If you do not want a particular click to swap to the edit view
       // for your widget, you should make sure it does not bubble

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apostrophe",
-  "version": "3.8.1",
+  "version": "3.11.0",
   "description": "The Apostrophe Content Management System.",
   "main": "index.js",
   "scripts": {
@@ -28,16 +28,16 @@
   "license": "MIT",
   "dependencies": {
     "@apostrophecms/vue-color": "^2.8.2",
-    "@babel/core": "^7.14.3",
-    "@babel/preset-env": "^7.14.4",
+    "@babel/core": "^7.16.7",
+    "@babel/preset-env": "^7.16.7",
     "@tiptap/extension-highlight": "^2.0.0-beta.13",
     "@tiptap/extension-link": "^2.0.0-beta.17",
     "@tiptap/extension-text-align": "^2.0.0-beta.17",
     "@tiptap/extension-text-style": "^2.0.0-beta.13",
-    "@tiptap/extension-underline": "^2.0.0-beta.14",
-    "@tiptap/starter-kit": "^2.0.0-beta.75",
-    "@tiptap/vue-2": "^2.0.0-beta.34",
-    "autoprefixer": "^10.2.4",
+    "@tiptap/extension-underline": "^2.0.0-beta.22",
+    "@tiptap/starter-kit": "^2.0.0-beta.164",
+    "@tiptap/vue-2": "^2.0.0-beta.73",
+    "autoprefixer": "^10.4.1",
     "babel-loader": "^8.2.2",
     "bluebird": "^3.7.2",
     "body-parser": "^1.18.2",
@@ -68,7 +68,7 @@
     "he": "^0.5.0",
     "html-to-text": "^5.1.1",
     "i18next": "^20.3.2",
-    "i18next-http-middleware": "^3.1.4",
+    "i18next-http-middleware": "^3.1.5",
     "import-fresh": "^3.3.0",
     "is-wsl": "^2.2.0",
     "jsdom": "^17.0.0",
@@ -95,7 +95,7 @@
     "resolve": "^1.19.0",
     "resolve-from": "^5.0.0",
     "sanitize-html": "^2.0.0",
-    "sass": "^1.34.1",
+    "sass": "^1.45.2",
     "sass-loader": "^10.1.1",
     "server-destroy": "^1.0.1",
     "sluggo": "^0.3.0",
@@ -110,7 +110,7 @@
     "uploadfs": "^1.17.1",
     "v-tooltip": "^2.0.3",
     "vue": "^2.6.14",
-    "vue-click-outside-element": "^1.0.13",
+    "vue-click-outside-element": "^1.0.15",
     "vue-loader": "^15.9.6",
     "vue-material-design-icons": "~4.12.1",
     "vue-style-loader": "^4.1.2",

package/test/moog.js

@@ -284,6 +284,54 @@ describe('moog', function() {
       assert(myObject.fieldsGroups.basics.fields.includes('five'));
     });
 
+    it('should order fields with the last option unless the order array overrides', async function() {
+      const moog = require('../lib/moog.js')({});
+
+      moog.define('unorderedObject', {
+        cascades: [ 'fields' ],
+        fields: {
+          add: {
+            first: { type: 'string' },
+            last: {
+              type: 'string',
+              last: true
+            },
+            second: { type: 'string' },
+            third: { type: 'string' }
+          }
+        }
+      });
+
+      moog.define('orderedObject', {
+        cascades: [ 'fields' ],
+        fields: {
+          add: {
+            first: { type: 'string' },
+            last: {
+              type: 'string',
+              last: true
+            },
+            second: { type: 'string' },
+            third: { type: 'string' }
+          },
+          order: [ 'last', 'third', 'second', 'first' ]
+        }
+      });
+      const unordered = await moog.create('unorderedObject', {});
+      assert(unordered);
+      assert(Object.keys(unordered.fields)[0] === 'first');
+      assert(Object.keys(unordered.fields)[1] === 'second');
+      assert(Object.keys(unordered.fields)[2] === 'third');
+      assert(Object.keys(unordered.fields)[3] === 'last');
+
+      const ordered = await moog.create('orderedObject', {});
+      assert(ordered);
+      assert(Object.keys(ordered.fields)[0] === 'last');
+      assert(Object.keys(ordered.fields)[1] === 'third');
+      assert(Object.keys(ordered.fields)[2] === 'second');
+      assert(Object.keys(ordered.fields)[3] === 'first');
+    });
+
     // ==================================================
     // `redefine` AND `isDefined`
     // ==================================================

package/test-lib/util.js

@@ -43,12 +43,14 @@ async function create(options) {
   };
   // Automatically configure Express, but not if we're in a special
   // environment where the default apostrophe modules don't initialize
+  // TODO: Remove __testDefaults references in 4.x major version or formalize
+  // intended usage with documentation.
   if (!config.__testDefaults) {
     config.modules = config.modules || {};
     const express = config.modules['@apostrophecms/express'] || {};
     express.options = express.options || {};
-    // Allow OS to choose open port
-    express.options.port = null;
+    // Allow OS to choose open port if not explicitly set.
+    express.options.port = express.options.port || null;
     express.options.address = express.options.address || 'localhost';
     express.options.session = express.options.session || {};
     express.options.session.secret = express.options.session.secret || 'test';

package/.circleci/config.yml

@@ -1,94 +0,0 @@
-version: 2
-jobs:
-  build-node14-mongo5:
-    docker:
-      - image: circleci/node:14-browsers
-      - image: mongo:5.0
-    steps:
-      - checkout
-      - run:
-          name: update-npm
-          command: 'sudo npm install -g npm@7'
-      - restore_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
-      - run:
-          name: install-npm-wee
-          command: npm install
-      - save_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
-          paths:
-            - ./node_modules
-      - run:
-          name: test
-          command: npm test
-  build-node14-mongo44:
-    docker:
-      - image: circleci/node:14-browsers
-      - image: mongo:4.4
-    steps:
-      - checkout
-      - run:
-          name: update-npm
-          command: 'sudo npm install -g npm@7'
-      - restore_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
-      - run:
-          name: install-npm-wee
-          command: npm install
-      - save_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
-          paths:
-            - ./node_modules
-      - run:
-          name: test
-          command: npm test
-  build-node14-mongo42:
-    docker:
-      - image: circleci/node:14-browsers
-      - image: mongo:4.2
-    steps:
-      - checkout
-      - run:
-          name: update-npm
-          command: 'sudo npm install -g npm@7'
-      - restore_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
-      - run:
-          name: install-npm-wee
-          command: npm install
-      - save_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
-          paths:
-            - ./node_modules
-      - run:
-          name: test
-          command: npm test
-  build-node12:
-    docker:
-      - image: circleci/node:12-browsers
-      - image: mongo:3.6.11
-    steps:
-      - checkout
-      - run:
-          name: update-npm
-          command: "sudo npm install -g npm"
-      - restore_cache:
-          key: dependency-cache-{{ .Branch }}-{{ checksum "package-lock.json" }}
-      - run:
-          name: install-npm-wee
-          command: npm install
-      - save_cache:
-          key: dependency-cache-{{ .Branch }}-{{ checksum "package-lock.json" }}
-          paths:
-            - ./node_modules
-      - run:
-          name: test
-          command: npm test
-workflows:
-  version: 2
-  build:
-    jobs:
-      - build-node14-mongo5
-      - build-node14-mongo44
-      - build-node14-mongo42
-      - build-node12

package/.github/pull_request_template.md

@@ -1,8 +0,0 @@
-Please ensure your pull request follows these guidelines:
-
-- [ ] Link to the related issue with requirements and/or clearly describe 1) what problem this solves and 2) the requirements to review it against.
-- [ ] Update the `CHANGELOG.md` file with the added feature or fix. If there is not yet a heading for an upcoming release, add one following the established pattern.
-- [ ] Keep the pull request minimal! Break large updates into separate pull requests for individual features/fixes whenever possible. Small requests get reviewed more quickly.
-- [ ] All tests must pass, including the linters. Run `npm run lint` to test code linting independently.
-
-Thanks for contributing!

package/.scratch.md

@@ -1,2 +0,0 @@
-- `/deep/ .apos-button` to `:deep(.apos-button)`
-- Remove v-popover, v-tooltip, VueClickOutsideElement