apostrophe 3.42.0 → 3.43.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 3.43.0 (2023-03-29)
+
+### Adds
+
+* Add the possibility to override the default "Add Item" button label by setting the `itemLabel` option of an `array` field.
+* Adds `touch` task for every piece type. This task invokes `update` on each piece, which will execute all of the same event handlers that normally execute when a piece of that type is updated. Example usage: `node app article:touch`.
+
+### Fixes
+
+* Hide the suggestion help from the relationship input list when the user starts typing a search term.
+* Hide the suggestion hint from the relationship input list when the user starts typing a search term except when there are no matches to display.
+* Disable context menu for related items when their `relationship` field has no sub-[`fields`](https://v3.docs.apostrophecms.org/guide/relationships.html#providing-context-with-fields) configured.
+
 ## 3.42.0 (2023-03-16)
 
 ### Adds
@@ -31,17 +44,18 @@ current selection. Currently this works best with newly inserted documents.
 * Localized strings in the admin UI can now use `$t(key)` to localize a string inside
 an interpolated variable. This was accomplished by setting `skipOnVariables` to false
 for i18next, solely on the front end for admin UI purposes.
-* The syntax of the method defined for dynamic `choices` now accepts a module prefix to get the method from, and the `()` suffix.  
+* The syntax of the method defined for dynamic `choices` now accepts a module prefix to get the method from, and the `()` suffix.
 This has been done for consistency with the external conditions syntax shipped in the previous release. See the documentation for more information.
 * Added the `viewPermission` property of schema fields, and renamed `permission` to `editPermission` (with backwards
 compatibility) for clarity. You can now decide if a schema field requires permissions to be visible or editable.
 See the documentation for more information.
+* Display the right environment label on login page. By default, based on `NODE_ENV`, overriden by `environmentLabel` option in `@apostrophecms/login` module. The environment variable `APOS_ENV_LABEL` will override this. Note that `NODE_ENV` should generally only be set to `development` (the default) or `production` as many Node.js modules opt into optimizations suitable for all deployed environments when it is set to `production`. This is why we offer the separate `APOS_ENV_LABEL` variable.
 
-### Fixes 
+### Fixes
 
 * Do not log unnecessary "required" errors for hidden fields.
 * Fixed a bug that prevented "Text Align" from working properly in the rich text editor in certain cases.
-* Fix typo in `@apostrophecms/doc-type` and `@apostrophecms/submitted-drafts` where we were using `canCreate` instead of `showCreate` to display the `Create New` button or showing the `Copy` button in `Manager` modals. 
+* Fix typo in `@apostrophecms/doc-type` and `@apostrophecms/submitted-drafts` where we were using `canCreate` instead of `showCreate` to display the `Create New` button or showing the `Copy` button in `Manager` modals.
 * Send external condition results in an object so that numbers are supported as returned values.
 
 ## 3.41.1 (2023-03-07)
@@ -52,7 +66,7 @@ No changes. Publishing to make sure 3.x is tagged `latest` in npm, rather than 2
 
 ### Adds
 
-* Handle external conditions to display fields according to the result of a module method, or multiple methods from different modules.  
+* Handle external conditions to display fields according to the result of a module method, or multiple methods from different modules.
 This can be useful for displaying fields according to the result of an external API or any business logic run on the server. See the documentation for more information.
 
 ### Fixes

package/modules/@apostrophecms/i18n/i18n/en.json

@@ -5,6 +5,7 @@
   "addItem": "Add Item",
   "addRowAfter": "Add Row After",
   "addRowBefore": "Add Row Before",
+  "addType": "Add {{ type }}",
   "addWidgetType": "Add {{ label }}",
   "admin": "Admin",
   "affirmativeLabel": "Yes, continue.",

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

@@ -382,8 +382,9 @@ module.exports = {
             }
           }
         }
+
         return {
-          env: process.env.NODE_ENV || 'development',
+          env: process.env.APOS_ENV_LABEL || self.options.environmentLabel || process.env.NODE_ENV || 'development',
           name: (process.env.npm_package_name && process.env.npm_package_name.replace(/-/g, ' ')) || 'Apostrophe',
           version: aposPackage.version || '3',
           requirementProps

package/modules/@apostrophecms/login/ui/apos/components/TheAposLoginHeader.vue

@@ -110,7 +110,7 @@ export default {
       background: var(--a-danger);
     }
 
-    &--success {
+    &--success, &--staging {
       background: var(--a-warning);
     }
   }

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

@@ -1206,6 +1206,53 @@ module.exports = {
 
           console.log(`Done unlocalizing module ${self.name}`);
         }
+      },
+
+      touch: {
+        usage: 'Invoke this task to touch (update without any change) all docs of this type.',
+        async task(argv) {
+          const req = self.apos.task.getAdminReq();
+          let errCount = 0;
+          let count = 0;
+          let cursor;
+          const criteria = self.options.autopublish
+            ? { aposMode: 'draft' }
+            : {};
+
+          try {
+            // We have 30 minutes (by default) for each iteration.
+            // https://www.mongodb.com/docs/manual/reference/method/cursor.noCursorTimeout/#session-idle-timeout-overrides-nocursortimeout
+            cursor = (await self.find(req, criteria)
+              .locale(null)
+              .limit(0)
+              .toMongo())
+              .addCursorFlag('noCursorTimeout', true);
+
+            for await (const doc of cursor) {
+              try {
+                await self.update(req, doc);
+                count++;
+              } catch (e) {
+                errCount++;
+                self.apos.util.error(e);
+              }
+            }
+          } catch (error) {
+            self.apos.util.error(error);
+          } finally {
+            if (cursor) {
+              await cursor.close();
+            }
+          }
+          console.log(`Touched ${count} doc(s) with ${errCount} error(s)`);
+
+          // Return, useful for tests and internal API's
+          // It's in effect only when invoked via apos.task.invoke().
+          return {
+            touched: count,
+            errors: errCount
+          };
+        }
       }
     };
   }

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

@@ -52,7 +52,7 @@
             @input="setCheckedDocs"
             @item-clicked="editRelationship"
             :value="checkedDocs"
-            :has-relationship-schema="!!(relationshipField && relationshipField.schema)"
+            :relationship-schema="relationshipField?.schema"
           />
         </div>
       </AposModalRail>

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

@@ -118,7 +118,7 @@
         </component>
         <AposButton
           type="primary"
-          label="apostrophe:addItem"
+          :label="itemLabel"
           icon="plus-icon"
           :disabled="disableAdd()"
           :modifiers="['block']"
@@ -179,6 +179,14 @@ export default {
         handle: '.apos-drag-handle'
       };
     },
+    itemLabel() {
+      return this.field.itemLabel
+        ? {
+          key: 'apostrophe:addType',
+          type: this.$t(this.field.itemLabel)
+        }
+        : 'apostrophe:addItem';
+    },
     editLabel() {
       return {
         key: 'apostrophe:editType',

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

@@ -57,7 +57,7 @@
           :value="next"
           :duplicate="duplicate"
           :disabled="field.readOnly"
-          :has-relationship-schema="!!field.schema"
+          :relationship-schema="field.schema"
           :editor-label="field.editorLabel"
           :editor-icon="field.editorIcon"
         />
@@ -241,19 +241,21 @@ export default {
           qs
         }
       );
-      // filter items already selected
-      const first = this.suggestion;
-      const last = this.hint;
-      this.searchList = [ first ]
-        .concat((list.results || [])
-          .filter(item => !this.next.map(i => i._id).includes(item._id))
-          .map(item => ({
-            ...item,
-            disabled: this.disableUnpublished && !item.lastPublishedAt
-          }))
-        )
-        .concat(last);
 
+      const removeSelectedItem = item => !this.next.map(i => i._id).includes(item._id);
+      const formatItems = item => ({
+        ...item,
+        disabled: this.disableUnpublished && !item.lastPublishedAt
+      });
+
+      const results = (list.results || [])
+        .filter(removeSelectedItem)
+        .map(formatItems);
+
+      const suggestion = !qs.autocomplete && this.suggestion;
+      const hint = (!qs.autocomplete || !results.length) && this.hint;
+
+      this.searchList = [ suggestion, ...results, hint ].filter(Boolean);
       this.searching = false;
     },
     async input () {

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

@@ -28,7 +28,7 @@
           :size="13"
         />
         <AposContextMenu
-          v-if="hasRelationshipEditor && more.menu.length"
+          v-if="hasRelationshipFields && more.menu.length"
           :button="more.button"
           :menu="more.menu"
           @item-clicked="$emit('item-clicked', item)"
@@ -134,9 +134,9 @@ export default {
       type: Boolean,
       default: false
     },
-    hasRelationshipSchema: {
-      type: Boolean,
-      default: false
+    relationshipSchema: {
+      type: Array,
+      default: () => null
     },
     editorLabel: {
       type: String,
@@ -178,9 +178,14 @@ export default {
     },
     hasRelationshipEditor() {
       if (this.item.attachment && this.item.attachment.group === 'images') {
-        return this.hasRelationshipSchema && this.item.attachment._isCroppable;
+        return this.relationshipSchema && this.item.attachment._isCroppable;
       }
-      return this.hasRelationshipSchema;
+      return this.relationshipSchema;
+    },
+    hasRelationshipFields() {
+      return this.hasRelationshipEditor &&
+        Array.isArray(this.relationshipSchema) &&
+        this.relationshipSchema.length;
     }
   },
   methods: {

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

@@ -31,7 +31,7 @@
           :parent="listId"
           :slat-count="next.length"
           :removable="removable"
-          :has-relationship-schema="hasRelationshipSchema"
+          :relationship-schema="relationshipSchema"
           :editor-label="editorLabel"
           :editor-icon="editorIcon"
         />
@@ -66,9 +66,9 @@ export default {
       type: String,
       default: null
     },
-    hasRelationshipSchema: {
-      type: Boolean,
-      default: false
+    relationshipSchema: {
+      type: Array,
+      default: () => null
     },
     editorLabel: {
       type: String,

package/package.json

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

package/test/login.js

@@ -23,7 +23,8 @@ describe('Login', function() {
         },
         '@apostrophecms/login': {
           options: {
-            passwordReset: true
+            passwordReset: true,
+            environmentLabel: 'test'
           }
         }
       }
@@ -43,6 +44,10 @@ describe('Login', function() {
     assert(apos.user.safe.remove);
     const response = await apos.user.safe.removeMany({});
     assert(response.result.ok === 1);
+
+    const loginModule = apos.modules['@apostrophecms/login'];
+    const context = await loginModule.getContext();
+    assert(context.env === 'test');
   });
 
   it('should be able to insert test user', async function() {

package/test/pieces-tasks.js

@@ -0,0 +1,94 @@
+const assert = require('assert').strict;
+const t = require('../test-lib/test.js');
+
+describe('Pieces - tasks', function() {
+  this.timeout(t.timeout);
+  let apos;
+
+  before(async function () {
+    apos = await t.create({
+      root: module,
+      modules: {
+        article: {
+          extend: '@apostrophecms/piece-type',
+          options: {
+            alias: 'article',
+            name: 'article',
+            label: 'Article'
+          }
+        }
+      }
+    });
+  });
+
+  beforeEach(async function () {
+    await apos.doc.db.deleteMany({ type: 'article' });
+  });
+
+  after(function () {
+    return t.destroy(apos);
+  });
+
+  it('should generate pieces', async function () {
+    const before = await apos.doc.db.find({ type: 'article' }).count();
+    assert.equal(before, 0);
+    await apos.task.invoke('article:generate', {
+      total: 10
+    });
+    const after = await apos.doc.db.find({ type: 'article' }).count();
+    assert.equal(after, 20);
+  });
+
+  it('should touch pieces', async function () {
+    await apos.task.invoke('article:generate', {
+      total: 10
+    });
+    const docs = await apos.doc.db.find({ type: 'article' }).toArray();
+    assert.equal(docs.length, 20);
+
+    const result = await apos.task.invoke('article:touch');
+    assert.equal(result.touched, 20);
+    assert.equal(result.errors, 0);
+
+    const touched = await apos.doc.db.find({ type: 'article' }).toArray();
+    assert.equal(touched.length, 20);
+
+    for (const doc of touched) {
+      const old = docs.find(d => d._id === doc._id);
+      assert(old);
+      assert(old.updatedAt);
+      assert(doc.updatedAt);
+      assert.equal(
+        new Date(doc.updatedAt) > new Date(old.updatedAt),
+        true
+      );
+    }
+  });
+
+  it('should touch pieces with autopublish enabled', async function () {
+    apos.article.options.autopublish = true;
+    await apos.task.invoke('article:generate', {
+      total: 10
+    });
+    const docs = await apos.doc.db.find({ type: 'article' }).toArray();
+    assert.equal(docs.length, 30);
+
+    const result = await apos.task.invoke('article:touch');
+    assert.equal(result.touched, 10);
+    assert.equal(result.errors, 0);
+
+    const touched = await apos.doc.db.find({ type: 'article' }).toArray();
+    assert.equal(touched.length, 30);
+
+    for (const doc of touched) {
+      const old = docs.find(d => d._id === doc._id);
+      assert(old);
+      assert(old.updatedAt);
+      assert(doc.updatedAt);
+      assert.equal(
+        new Date(doc.updatedAt) > new Date(old.updatedAt),
+        true
+      );
+    }
+  });
+});