apostrophe 4.4.2 → 4.4.3

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 4.4.3 (2024-06-17)
+
+### Fixes
+
+* Do not use schema `field.def` when calling `convert`. Applying defaults to new documents is the job of `newInstance()` and similar code.
+If you wish a field to be mandatory use `required: true`.
+* As a convenience, using `POST` for pieces and pages with `_newInstance: true` keeps any additional `req.body` properties in the API response.
+This feature unofficially existed before, it is now supported.
+
 ## 4.4.2 (2024-06-14)
 
 ### Fixes
@@ -58,13 +67,19 @@ We will now end up with page B slug as `/peer/page` and not `/peer/peer/page` as
 * Detect shortcut conflicts when using multiple shortcuts.
 * Updating schema fields as read-only no longer reset the value when updating the document.
 * Fixes stylelint config file, uses config from our shared configuration, fixes all lint errors. 
-* Removes `$nextTick` use to re render schema in `AposArrayEditor` because it was triggering weird vue error in production.
-Instead, makes the AposSchema for loop keys more unique using `modelValue.data._id`, 
-if document changes it re-renders schema fields.
 * Fixes `TheAposCommandMenu` modals not computing shortcuts from the current opened modal.
 * Fixes select boxes of relationships, we can now check manually published relationships, and `AposSlatList` renders properly checked relationships.
 * Fixes issues in `AposInputArray` on production build to be able to add, remove and edit array items after `required` error.
 * Relationships browse button isn't disabled when max is reached.
+* In media manager images checkboxes are disabled when max is reached.
+
+## 4.3.3 (2024-06-04)
+
+### Fixes
+
+* Removes `$nextTick` use to re render schema in `AposArrayEditor` because it was triggering weird vue error in production.
+Instead, makes the AposSchema for loop keys more unique using `modelValue.data._id`, 
+if document changes it re-renders schema fields.
 * In media manager image checkboxes are disabled when max is reached.
 * Fixes tiptap bubble menu jumping on Firefox when clicking on buttons. Also fixes the fact that 
 double clicking on bubble menu out of buttons would prevent it from closing when unfocusing the rich text area.

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

@@ -319,7 +319,11 @@ module.exports = {
           // simply get a new page doc and return it
           const parentPage = await self.findForEditing(req, self.getIdCriteria(targetId))
             .permission('create', '@apostrophecms/any-page-type').toObject();
-          const newChild = self.newChild(parentPage);
+          const { _newInstance, ...body } = req.body;
+          const newChild = {
+            ...self.newChild(parentPage),
+            ...body
+          };
           newChild._previewable = true;
           return newChild;
         }
@@ -350,7 +354,6 @@ module.exports = {
             page = self.newChild(parentPage);
           }
           await manager.convert(req, input, page, {
-            onlyPresentFields: true,
             copyingId
           });
           await self.insert(req, targetPage._id, position, page, { lock: false });

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

@@ -301,7 +301,11 @@ module.exports = {
       async post(req) {
         await self.publicApiCheckAsync(req);
         if (req.body._newInstance) {
-          const newInstance = self.newInstance();
+          const { _newInstance, ...body } = req.body;
+          const newInstance = {
+            ...self.newInstance(),
+            ...body
+          };
           newInstance._previewable = self.addUrlsViaModule && (await self.addUrlsViaModule.readyToAddUrlsToPieces(req, self.name));
           delete newInstance._url;
           return newInstance;
@@ -817,7 +821,6 @@ module.exports = {
         const piece = self.newInstance();
         const copyingId = self.apos.launder.id(input._copyingId);
         await self.convert(req, input, piece, {
-          onlyPresentFields: true,
           copyingId
         });
         await self.emit('afterConvert', req, input, piece);

package/modules/@apostrophecms/schema/lib/addFieldTypes.js

@@ -96,7 +96,7 @@ module.exports = (self) => {
   self.addFieldType({
     name: 'string',
     convert(req, field, data, destination) {
-      destination[field.name] = self.apos.launder.string(data[field.name], field.def);
+      destination[field.name] = self.apos.launder.string(data[field.name]);
       destination[field.name] = checkStringLength(destination[field.name], field.min, field.max);
       // If field is required but empty (and client side didn't catch that)
       // This is new and until now if JS client side failed, then it would
@@ -165,7 +165,7 @@ module.exports = (self) => {
     convert (req, field, data, destination) {
       const options = self.getSlugFieldOptions(field, data);
 
-      destination[field.name] = self.apos.util.slugify(self.apos.launder.string(data[field.name], field.def), options);
+      destination[field.name] = self.apos.util.slugify(self.apos.launder.string(data[field.name]), options);
 
       if (field.page) {
         if (!(destination[field.name].charAt(0) === '/')) {
@@ -205,7 +205,7 @@ module.exports = (self) => {
   self.addFieldType({
     name: 'boolean',
     convert: function (req, field, data, destination) {
-      destination[field.name] = self.apos.launder.boolean(data[field.name], field.def);
+      destination[field.name] = self.apos.launder.boolean(data[field.name]);
     },
     isEmpty: function (field, value) {
       return !value && value !== false;
@@ -256,7 +256,7 @@ module.exports = (self) => {
   self.addFieldType({
     name: 'color',
     async convert(req, field, data, destination) {
-      destination[field.name] = self.apos.launder.string(data[field.name], field.def);
+      destination[field.name] = self.apos.launder.string(data[field.name]);
 
       if (field.required && (_.isUndefined(destination[field.name]) || !destination[field.name].toString().length)) {
         throw self.apos.error('required');
@@ -366,7 +366,7 @@ module.exports = (self) => {
     dynamicChoices: true,
     async convert(req, field, data, destination) {
       const choices = await self.getChoices(req, field);
-      destination[field.name] = self.apos.launder.select(data[field.name], choices, field.def);
+      destination[field.name] = self.apos.launder.select(data[field.name], choices);
     },
     index: function (value, field, texts) {
       const silent = field.silent === undefined ? true : field.silent;
@@ -438,7 +438,7 @@ module.exports = (self) => {
     name: 'integer',
     vueComponent: 'AposInputString',
     async convert(req, field, data, destination) {
-      destination[field.name] = self.apos.launder.integer(data[field.name], field.def, field.min, field.max);
+      destination[field.name] = self.apos.launder.integer(data[field.name], undefined, field.min, field.max);
       if (field.required && ((data[field.name] == null) || !data[field.name].toString().length)) {
         throw self.apos.error('required');
       }
@@ -492,7 +492,7 @@ module.exports = (self) => {
     name: 'float',
     vueComponent: 'AposInputString',
     async convert(req, field, data, destination) {
-      destination[field.name] = self.apos.launder.float(data[field.name], field.def, field.min, field.max);
+      destination[field.name] = self.apos.launder.float(data[field.name], undefined, field.min, field.max);
       if (field.required && (_.isUndefined(data[field.name]) || !data[field.name].toString().length)) {
         throw self.apos.error('required');
       }
@@ -563,7 +563,7 @@ module.exports = (self) => {
     name: 'url',
     vueComponent: 'AposInputString',
     async convert(req, field, data, destination) {
-      destination[field.name] = self.apos.launder.url(data[field.name], field.def, true);
+      destination[field.name] = self.apos.launder.url(data[field.name], undefined, true);
 
       if (field.required && (data[field.name] == null || !data[field.name].toString().length)) {
         throw self.apos.error('required');
@@ -642,7 +642,7 @@ module.exports = (self) => {
         return;
       }
 
-      destination[field.name] = self.apos.launder.date(newDateVal, field.def);
+      destination[field.name] = self.apos.launder.date(newDateVal);
     },
     validate: function (field, options, warn, fail) {
       if (field.max && !field.max.match(dateRegex)) {
@@ -698,7 +698,7 @@ module.exports = (self) => {
     name: 'time',
     vueComponent: 'AposInputString',
     async convert(req, field, data, destination) {
-      destination[field.name] = self.apos.launder.time(data[field.name], field.def);
+      destination[field.name] = self.apos.launder.time(data[field.name]);
     }
   });
 
@@ -718,7 +718,7 @@ module.exports = (self) => {
       // This is the only field type that we never update unless
       // there is actually a new value — a blank password is not cool. -Tom
       if (data[field.name]) {
-        destination[field.name] = self.apos.launder.string(data[field.name], field.def);
+        destination[field.name] = self.apos.launder.string(data[field.name]);
 
         destination[field.name] = checkStringLength(destination[field.name], field.min, field.max);
       }
@@ -733,7 +733,7 @@ module.exports = (self) => {
     name: 'range',
     vueComponent: 'AposInputRange',
     async convert(req, field, data, destination) {
-      destination[field.name] = self.apos.launder.float(data[field.name], field.def, field.min, field.max);
+      destination[field.name] = self.apos.launder.float(data[field.name], undefined, field.min, field.max);
       if (field.required && (_.isUndefined(data[field.name]) || !data[field.name].toString().length)) {
         throw self.apos.error('required');
       }

package/package.json

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

package/test/pages-rest.js

@@ -1,5 +1,6 @@
 const t = require('../test-lib/test.js');
 const assert = require('assert');
+const cuid = require('cuid');
 
 const areaConfig = {
   '@apostrophecms/image': {},
@@ -1618,4 +1619,105 @@ describe('Pages REST', function() {
     }
   });
 
+  it('can insert a test-page with _newInstance and additional properties', async function() {
+    const newInstance = await apos.http.post('/api/v1/@apostrophecms/page', {
+      body: {
+        _newInstance: true,
+        slug: '/page-01',
+        type: 'test-page',
+        title: 'Page 01'
+      },
+      jar
+    });
+    const inserted = await apos.http.post('/api/v1/@apostrophecms/page', {
+      body: {
+        ...newInstance,
+        body: {
+          metaType: 'area',
+          items: [
+            {
+              metaType: 'widget',
+              type: '@apostrophecms/rich-text',
+              id: cuid(),
+              content: '<p>This is the product key product with relationship</p>'
+            }
+          ]
+        }
+      },
+      jar
+    });
+
+    const actual = {
+      newInstance,
+      inserted
+    };
+    const expected = {
+      newInstance: {
+        _previewable: true,
+        orphan: false,
+        slug: '/page-01',
+        title: 'Page 01',
+        type: 'test-page',
+        visibility: 'public'
+      },
+      inserted: {
+        _ancestors: inserted._ancestors,
+        _create: true,
+        _delete: true,
+        _edit: true,
+        _id: inserted._id,
+        _publish: true,
+        _url: '/page-01',
+        aposDocId: inserted.aposDocId,
+        aposLocale: 'en:published',
+        aposMode: 'published',
+        archived: false,
+        body: {
+          _docId: inserted.body._docId,
+          _edit: true,
+          _id: inserted.body._id,
+          items: [
+            {
+              _docId: inserted.body.items.at(0)._docId,
+              _edit: true,
+              _id: inserted.body.items.at(0)._id,
+              aposPlaceholder: false,
+              content: '<p>This is the product key product with relationship</p>',
+              imageIds: [],
+              metaType: 'widget',
+              permalinkIds: [],
+              type: '@apostrophecms/rich-text'
+            }
+          ],
+          metaType: 'area'
+        },
+        cacheInvalidatedAt: inserted.cacheInvalidatedAt,
+        color: '',
+        createdAt: inserted.createdAt,
+        highSearchText: inserted.highSearchText,
+        highSearchWords: inserted.highSearchWords,
+        lastPublishedAt: inserted.lastPublishedAt,
+        level: 1,
+        lowSearchText: inserted.lowSearchText,
+        metaType: 'doc',
+        orphan: false,
+        path: inserted.path,
+        rank: inserted.rank,
+        searchSummary: inserted.searchSummary,
+        slug: '/page-01',
+        title: 'Page 01',
+        titleSortified: inserted.titleSortified,
+        type: 'test-page',
+        updatedAt: inserted.updatedAt,
+        updatedBy: {
+          _id: inserted.updatedBy._id,
+          title: 'admin',
+          username: 'admin'
+        },
+        visibility: 'public'
+      }
+    };
+
+    assert.deepEqual(actual, expected);
+  });
 });

package/test/pieces.js

@@ -964,6 +964,129 @@ describe('Pieces', function() {
     relatedProductId = response._id;
   });
 
+  it('can insert a product with _newInstance and additional properties', async function() {
+    const newInstance = await apos.http.post('/api/v1/product', {
+      body: {
+        _newInstance: true,
+        title: 'Product 01'
+      },
+      jar
+    });
+    const inserted = await apos.http.post('/api/v1/product', {
+      body: {
+        ...newInstance,
+        body: {
+          metaType: 'area',
+          items: [
+            {
+              metaType: 'widget',
+              type: '@apostrophecms/rich-text',
+              id: cuid(),
+              content: '<p>This is the product key product with relationship</p>'
+            }
+          ]
+        }
+      },
+      jar
+    });
+
+    const actual = {
+      newInstance,
+      inserted
+    };
+    const expected = {
+      newInstance: {
+        _articles: null,
+        _previewable: true,
+        archived: false,
+        body: {
+          _id: newInstance.body._id,
+          items: [],
+          metaType: 'area'
+        },
+        color: null,
+        photo: null,
+        relationshipsInArray: [],
+        relationshipsInObject: {
+          _articles: null
+        },
+        slug: '',
+        title: 'Product 01',
+        type: 'product',
+        visibility: 'public'
+      },
+      inserted: {
+        _articles: [],
+        _create: true,
+        _delete: true,
+        _edit: true,
+        _id: inserted._id,
+        _parent: inserted._parent,
+        _parentSlug: '/products',
+        _parentUrl: '/products',
+        _publish: true,
+        _url: '/products/product-01',
+        aposDocId: inserted.aposDocId,
+        aposLocale: 'en:published',
+        aposMode: 'published',
+        archived: false,
+        articlesFields: {},
+        articlesIds: [],
+        body: {
+          _docId: inserted.body._docId,
+          _edit: true,
+          _id: inserted.body._id,
+          items: [
+            {
+              _docId: inserted.body.items.at(0)._docId,
+              _edit: true,
+              _id: inserted.body.items.at(0)._id,
+              aposPlaceholder: false,
+              content: '<p>This is the product key product with relationship</p>',
+              imageIds: [],
+              metaType: 'widget',
+              permalinkIds: [],
+              type: '@apostrophecms/rich-text'
+            }
+          ],
+          metaType: 'area'
+        },
+        cacheInvalidatedAt: inserted.cacheInvalidatedAt,
+        color: null,
+        createdAt: inserted.createdAt,
+        highSearchText: inserted.highSearchText,
+        highSearchWords: inserted.highSearchWords,
+        lastPublishedAt: inserted.lastPublishedAt,
+        lowSearchText: inserted.lowSearchText,
+        metaType: 'doc',
+        photo: null,
+        relationshipsInArray: [],
+        relationshipsInObject: {
+          _articles: [],
+          _id: inserted.relationshipsInObject._id,
+          articlesFields: {},
+          articlesIds: [],
+          metaType: 'object',
+          scopedObjectName: 'doc.product.relationshipsInObject'
+        },
+        searchSummary: inserted.searchSummary,
+        slug: 'product-01',
+        title: 'Product 01',
+        titleSortified: inserted.titleSortified,
+        type: 'product',
+        updatedAt: inserted.updatedAt,
+        updatedBy: {
+          _id: inserted.updatedBy._id,
+          title: 'admin',
+          username: 'admin'
+        },
+        visibility: 'public'
+      }
+    };
+
+    assert.deepEqual(actual, expected);
+  });
+
   it('can GET a product with relationships', async function() {
     const response = await apos.http.get('/api/v1/product');
     assert(response);

package/test/schemas.js

@@ -1326,7 +1326,7 @@ describe('Schemas', function() {
     assert(result.name === input.name);
     assert(result.address === input.address);
     // default
-    assert(result.variety === simpleFields[2].choices[0].value);
+    assert(result.variety === undefined);
     assert(result.slug === 'this-is-cool');
   });