cozy-client 24.10.2 → 25.0.3

package/CHANGELOG.md

@@ -3,6 +3,53 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [25.0.3](https://github.com/cozy/cozy-client/compare/v25.0.2...v25.0.3) (2021-10-21)
+
+
+### Bug Fixes
+
+* Add id in CozyClientDocument for RealTime ([5e242d6](https://github.com/cozy/cozy-client/commit/5e242d6d5fcb34e9f09c8b5661133b63aa35f93e))
+
+
+
+
+
+## [25.0.2](https://github.com/cozy/cozy-client/compare/v25.0.1...v25.0.2) (2021-10-14)
+
+**Note:** Version bump only for package cozy-client
+
+
+
+
+
+## [25.0.1](https://github.com/cozy/cozy-client/compare/v25.0.0...v25.0.1) (2021-10-13)
+
+
+### Bug Fixes
+
+* Do not save target document after add/remove references ([62902ce](https://github.com/cozy/cozy-client/commit/62902ce158f1b20da241ae6c42e5cc63ca0205bc))
+* Normalize file relationship response ([f5f465f](https://github.com/cozy/cozy-client/commit/f5f465f05a4885981f7bb1f5c2a4c1d968e29449))
+
+
+
+
+
+# [25.0.0](https://github.com/cozy/cozy-client/compare/v24.10.2...v25.0.0) (2021-10-12)
+
+
+### Bug Fixes
+
+* Doc created by Save should use _type to define _type ([61f9559](https://github.com/cozy/cozy-client/commit/61f95599359f9bbf02f0f2a689fa4b5aa5577508))
+
+
+### BREAKING CHANGES
+
+* save() must use argument with `_type` property
+
+
+
+
+
 ## [24.10.2](https://github.com/cozy/cozy-client/compare/v24.10.1...v24.10.2) (2021-10-11)
 
 

package/dist/CozyClient.js

@@ -785,39 +785,60 @@ var CozyClient = /*#__PURE__*/function () {
     value: function validate(document) {
       return this.schema.validate(document);
     }
+    /**
+     * Create or update a document on the server
+     *
+     * @param  {object} doc - Document to save
+     * @param  {object} mutationOptions - Mutation options
+     * @returns {Promise}
+     */
+
   }, {
     key: "save",
     value: function () {
       var _save = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5(doc) {
         var mutationOptions,
+            _type,
+            attributes,
             normalizedDoc,
             ret,
             _args5 = arguments;
+
         return _regenerator.default.wrap(function _callee5$(_context5) {
           while (1) {
             switch (_context5.prev = _context5.next) {
               case 0:
                 mutationOptions = _args5.length > 1 && _args5[1] !== undefined ? _args5[1] : {};
+                _type = doc._type, attributes = (0, _objectWithoutProperties2.default)(doc, ["_type"]);
+
+                if (_type) {
+                  _context5.next = 4;
+                  break;
+                }
+
+                throw new Error('The document must have a `_type` property');
+
+              case 4:
                 normalizedDoc = _objectSpread({
-                  _type: doc.type
-                }, doc);
-                _context5.next = 4;
+                  _type: _type
+                }, attributes);
+                _context5.next = 7;
                 return this.schema.validate(normalizedDoc);
 
-              case 4:
+              case 7:
                 ret = _context5.sent;
 
                 if (!(ret !== true)) {
-                  _context5.next = 7;
+                  _context5.next = 10;
                   break;
                 }
 
                 throw new Error('Validation failed');
 
-              case 7:
+              case 10:
                 return _context5.abrupt("return", this.mutate(this.getDocumentSavePlan(normalizedDoc), mutationOptions));
 
-              case 8:
+              case 11:
               case "end":
                 return _context5.stop();
             }
@@ -2390,7 +2411,7 @@ var CozyClient = /*#__PURE__*/function () {
 CozyClient.hooks = CozyClient.hooks || {};
 CozyClient.fetchPolicies = _policies.default; //COZY_CLIENT_VERSION_PACKAGE in replaced by babel. See babel config
 
-CozyClient.version = "24.10.2";
+CozyClient.version = "25.0.3";
 
 _microee.default.mixin(CozyClient);
 

package/dist/CozyClient.spec.js

@@ -677,7 +677,7 @@ describe('CozyClient', () => {
 
   describe('save', () => {
     it('should add the _type if not present', async () => {
-      const todo = { type: 'io.cozy.todos', label: 'Buy croissants' }
+      const todo = { _type: 'io.cozy.todos', label: 'Buy croissants' }
       client.store.dispatch.mockReset()
       await client.save(todo)
       const dispatchCalls = client.store.dispatch.mock.calls
@@ -1754,6 +1754,16 @@ describe('file creation', () => {
   it('should support creating a file with references', async () => {
     const { client } = setup()
     jest.spyOn(client, 'requestMutation')
+    client.stackClient.fetchJSON = jest
+      .fn()
+      .mockResolvedValueOnce({
+        data: {
+          _id: '1337'
+        }
+      })
+      .mockResolvedValueOnce({
+        data: [{ id: 1, type: 'io.cozy.files' }]
+      })
     await client.create(
       'io.cozy.files',
       {
@@ -1766,6 +1776,9 @@ describe('file creation', () => {
         icons: [{ _id: 1, _type: 'io.cozy.files' }]
       }
     )
+    client.stackClient.fetchJSON = jest.fn().mockResolvedValue({
+      data: [{ id: '1337', type: 'io.cozy.files' }]
+    })
     const requestMutationCalls = client.requestMutation.mock.calls
     const lastCall = requestMutationCalls[requestMutationCalls.length - 1]
     expect(lastCall[0]).toEqual(

package/dist/RealTimeQueries.js

@@ -40,6 +40,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
  */
 var normalizeDoc = function normalizeDoc(couchDBDoc, doctype) {
   return _objectSpread({
+    id: couchDBDoc._id,
     _type: doctype
   }, couchDBDoc);
 };

package/dist/RealTimeQueries.spec.jsx

@@ -38,6 +38,7 @@ describe('RealTimeQueries', () => {
         definition: {
           document: {
             _id: 'mock-created',
+            id: 'mock-created',
             _type: 'io.cozy.files',
             type: 'file'
           },
@@ -47,6 +48,7 @@ describe('RealTimeQueries', () => {
         response: {
           data: {
             _id: 'mock-created',
+            id: 'mock-created',
             _type: 'io.cozy.files',
             type: 'file'
           }
@@ -60,6 +62,7 @@ describe('RealTimeQueries', () => {
       definition: {
         document: {
           _id: 'mock-updated',
+          id: 'mock-updated',
           _type: 'io.cozy.files',
           type: 'file'
         },
@@ -69,6 +72,7 @@ describe('RealTimeQueries', () => {
       response: {
         data: {
           _id: 'mock-updated',
+          id: 'mock-updated',
           _type: 'io.cozy.files',
           type: 'file'
         }
@@ -81,6 +85,7 @@ describe('RealTimeQueries', () => {
       definition: {
         document: {
           _id: 'mock-deleted',
+          id: 'mock-deleted',
           _type: 'io.cozy.files',
           type: 'file',
           _deleted: true
@@ -91,6 +96,7 @@ describe('RealTimeQueries', () => {
       response: {
         data: {
           _id: 'mock-deleted',
+          id: 'mock-deleted',
           _type: 'io.cozy.files',
           type: 'file',
           _deleted: true
@@ -118,6 +124,7 @@ describe('RealTimeQueries', () => {
         definition: {
           document: {
             _id: 'mock-created',
+            id: 'mock-created',
             _type: 'io.cozy.oauth.clients',
             client_kind: 'desktop',
             client_name: 'Cozy Drive (hostname)'
@@ -128,6 +135,7 @@ describe('RealTimeQueries', () => {
         response: {
           data: {
             _id: 'mock-created',
+            id: 'mock-created',
             _type: 'io.cozy.oauth.clients',
             client_kind: 'desktop',
             client_name: 'Cozy Drive (hostname)'

package/dist/associations/HasMany.js

@@ -192,18 +192,14 @@ var HasMany = /*#__PURE__*/function (_Association) {
       return this.removeById(ids);
     }
     /**
-     * Add a referenced document by id. You need to call save()
-     * in order to synchronize your document with the store.
-     *
-     * @todo We shouldn't create the array of relationship manually since
-     * it'll not be present in the store as well.
-     * We certainly should use something like `updateRelationship`
+     * Update target document with relationships
      *
+     * @param {string[]} idsArg - The ids to add as a relationship
      */
 
   }, {
-    key: "addById",
-    value: function addById(idsArg) {
+    key: "addTargetRelationships",
+    value: function addTargetRelationships(idsArg) {
       var _this2 = this,
           _this$target$relation;
 
@@ -228,17 +224,43 @@ var HasMany = /*#__PURE__*/function (_Association) {
       (_this$target$relation = this.target.relationships[this.name].data).push.apply(_this$target$relation, (0, _toConsumableArray2.default)(newRelations));
 
       this.updateMetaCount();
+    }
+    /**
+     * Add a referenced document by id. You need to call save()
+     * in order to synchronize your document with the store.
+     *
+     * @todo We shouldn't create the array of relationship manually since
+     * it'll not be present in the store as well.
+     * We certainly should use something like `updateRelationship`
+     *
+     */
+
+  }, {
+    key: "addById",
+    value: function addById(idsArg) {
+      this.addTargetRelationships(idsArg);
       return this.save(this.target);
     }
+    /**
+     * Remove relationships from target document
+     *
+     * @param {string[]} idsArg - The ids to remove from the target relationships
+     */
+
   }, {
-    key: "removeById",
-    value: function removeById(idsArg) {
+    key: "removeTargetRelationships",
+    value: function removeTargetRelationships(idsArg) {
       var ids = Array.isArray(idsArg) ? idsArg : [idsArg];
       this.target.relationships[this.name].data = this.target.relationships[this.name].data.filter(function (_ref2) {
         var _id = _ref2._id;
         return !ids.includes(_id);
       });
       this.updateMetaCount();
+    }
+  }, {
+    key: "removeById",
+    value: function removeById(idsArg) {
+      this.removeTargetRelationships(idsArg);
       return this.save(this.target);
     }
   }, {

package/dist/associations/HasManyFiles.js

@@ -164,10 +164,9 @@ var HasManyFiles = /*#__PURE__*/function (_HasMany) {
                 return this.mutate(this.addReferences(relations));
 
               case 4:
-                _context3.next = 6;
-                return (0, _get3.default)((0, _getPrototypeOf2.default)(HasManyFiles.prototype), "addById", this).call(this, ids);
+                this.addTargetRelationships(ids);
 
-              case 6:
+              case 5:
               case "end":
                 return _context3.stop();
             }
@@ -203,10 +202,9 @@ var HasManyFiles = /*#__PURE__*/function (_HasMany) {
                 return this.mutate(this.removeReferences(references));
 
               case 4:
-                _context4.next = 6;
-                return (0, _get3.default)((0, _getPrototypeOf2.default)(HasManyFiles.prototype), "removeById", this).call(this, ids);
+                this.removeTargetRelationships(ids);
 
-              case 6:
+              case 5:
               case "end":
                 return _context4.stop();
             }

package/dist/associations/HasManyFiles.spec.js

@@ -73,7 +73,6 @@ describe('HasManyFiles', () => {
       mutationType: 'ADD_REFERENCES_TO',
       referencedDocuments: [{ _type: DOCTYPE_FILES, _id: 4 }]
     })
-    expect(save).toHaveBeenCalled()
   })
 
   it('adds multiple relations', async () => {
@@ -92,7 +91,6 @@ describe('HasManyFiles', () => {
         { _type: DOCTYPE_FILES, _id: 5 }
       ]
     })
-    expect(save).toHaveBeenCalled()
   })
 
   it('removes relations', async () => {
@@ -103,7 +101,6 @@ describe('HasManyFiles', () => {
       mutationType: 'REMOVE_REFERENCES_TO',
       referencedDocuments: [{ _type: DOCTYPE_FILES, _id: 2 }]
     })
-    expect(save).toHaveBeenCalled()
   })
 
   it('adds multiple relations', async () => {
@@ -117,7 +114,6 @@ describe('HasManyFiles', () => {
         { _type: DOCTYPE_FILES, _id: 2 }
       ]
     })
-    expect(save).toHaveBeenCalled()
   })
 
   it('add wrong file relations', () => {