cozy-client 24.6.0 → 24.8.0

package/CHANGELOG.md

@@ -3,6 +3,49 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [24.8.0](https://github.com/cozy/cozy-client/compare/v24.7.0...v24.8.0) (2021-09-16)
+
+
+### Features
+
+* Makes queryAll faster with many requests ([17a9e23](https://github.com/cozy/cozy-client/commit/17a9e2397f72f94daafd03b49f1cebae5bad0ec3))
+
+
+
+
+
+# [24.7.0](https://github.com/cozy/cozy-client/compare/v24.6.2...v24.7.0) (2021-09-14)
+
+
+### Features
+
+* Add deprecating warning for set/unset ([210a816](https://github.com/cozy/cozy-client/commit/210a8162df0816fa96b0beb6d3e910ef9ae5e616))
+* Use add and remove API for both has-one and has-many ([8bc0a4b](https://github.com/cozy/cozy-client/commit/8bc0a4be3c70f2068556d3d0c169eb5d23ed5033))
+
+
+
+
+
+## [24.6.2](https://github.com/cozy/cozy-client/compare/v24.6.1...v24.6.2) (2021-09-14)
+
+
+### Bug Fixes
+
+* **deps:** update dependency open to v8 ([8590ae3](https://github.com/cozy/cozy-client/commit/8590ae3ac00c1109c625316b4449d6e3f1d8b6ab))
+* **deps:** update dependency url-search-params-polyfill to v8 ([7723a7d](https://github.com/cozy/cozy-client/commit/7723a7dbc9bab386cb9dbc9d0e7a751abb2e56fb))
+
+
+
+
+
+## [24.6.1](https://github.com/cozy/cozy-client/compare/v24.6.0...v24.6.1) (2021-09-13)
+
+**Note:** Version bump only for package cozy-client
+
+
+
+
+
 # [24.6.0](https://github.com/cozy/cozy-client/compare/v24.5.0...v24.6.0) (2021-09-13)
 
 **Note:** Version bump only for package cozy-client

package/dist/CozyClient.js

@@ -2386,7 +2386,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.6.0";
+CozyClient.version = "24.8.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/associations/HasMany.js

@@ -159,6 +159,38 @@ var HasMany = /*#__PURE__*/function (_Association) {
     value: function existsById(id) {
       return Boolean(this.containsById(id) && this.get(this.doctype, id));
     }
+    /**
+     * Add the relationships to the target document
+     *
+     * @param {CozyClientDocument[]} docsArg - Documents to add as relationships
+     * @returns {CozyClientDocument} The saved target document
+     */
+
+  }, {
+    key: "add",
+    value: function add(docsArg) {
+      var docs = Array.isArray(docsArg) ? docsArg : [docsArg];
+      var ids = docs.map(function (doc) {
+        return doc._id;
+      });
+      return this.addById(ids);
+    }
+    /**
+     * Remove the relationships from the target document
+     *
+     * @param {CozyClientDocument[]} docsArg - Documents to remove as relationships
+     * @returns {CozyClientDocument} The saved target document
+     */
+
+  }, {
+    key: "remove",
+    value: function remove(docsArg) {
+      var docs = Array.isArray(docsArg) ? docsArg : [docsArg];
+      var ids = docs.map(function (doc) {
+        return doc._id;
+      });
+      return this.removeById(ids);
+    }
     /**
      * Add a referenced document by id. You need to call save()
      * in order to synchronize your document with the store.

package/dist/associations/HasMany.spec.js

@@ -54,51 +54,87 @@ describe('HasMany', () => {
     }
   })
 
-  it('adds', () => {
-    hydrated.tasks.addById(4)
-    expect(hydrated.tasks.data).toEqual([
-      { doctype: 'io.cozy.tasks', id: 1 },
-      { doctype: 'io.cozy.tasks', id: 2 },
-      { doctype: 'io.cozy.tasks', id: 4 }
-    ])
-    expect(save).toHaveBeenCalled()
-  })
+  describe('add', () => {
+    it('adds by id', () => {
+      hydrated.tasks.addById(4)
+      expect(hydrated.tasks.data).toEqual([
+        { doctype: 'io.cozy.tasks', id: 1 },
+        { doctype: 'io.cozy.tasks', id: 2 },
+        { doctype: 'io.cozy.tasks', id: 4 }
+      ])
+      expect(save).toHaveBeenCalled()
+    })
 
-  it('doesnt add if already there', () => {
-    hydrated.tasks.addById(1)
-    expect(hydrated.tasks.data).toEqual([
-      { doctype: 'io.cozy.tasks', id: 1 },
-      { doctype: 'io.cozy.tasks', id: 2 }
-    ])
-  })
+    it('doesnt add if already there', () => {
+      hydrated.tasks.addById(1)
+      expect(hydrated.tasks.data).toEqual([
+        { doctype: 'io.cozy.tasks', id: 1 },
+        { doctype: 'io.cozy.tasks', id: 2 }
+      ])
+    })
 
-  it('adds multiple ids', () => {
-    hydrated.tasks.addById([4, 5])
-    expect(hydrated.tasks.data).toEqual([
-      { doctype: 'io.cozy.tasks', id: 1 },
-      { doctype: 'io.cozy.tasks', id: 2 },
-      { doctype: 'io.cozy.tasks', id: 4 },
-      { doctype: 'io.cozy.tasks', id: 5 }
-    ])
-  })
+    it('adds multiple ids', () => {
+      hydrated.tasks.addById([4, 5])
 
-  it('removes', () => {
-    hydrated.tasks.removeById(2)
-    expect(hydrated.tasks.data).toEqual([{ doctype: 'io.cozy.tasks', id: 1 }])
-    expect(save).toHaveBeenCalled()
-  })
+      expect(hydrated.tasks.data).toEqual([
+        { doctype: 'io.cozy.tasks', id: 1 },
+        { doctype: 'io.cozy.tasks', id: 2 },
+        { doctype: 'io.cozy.tasks', id: 4 },
+        { doctype: 'io.cozy.tasks', id: 5 }
+      ])
+    })
+
+    it('adds by doc', () => {
+      hydrated.tasks.add({ _id: 4 })
+      expect(hydrated.tasks.data).toEqual([
+        { doctype: 'io.cozy.tasks', id: 1 },
+        { doctype: 'io.cozy.tasks', id: 2 },
+        { doctype: 'io.cozy.tasks', id: 4 }
+      ])
+    })
 
-  it('doesnt remove if not there', () => {
-    hydrated.tasks.removeById(3)
-    expect(hydrated.tasks.data).toEqual([
-      { doctype: 'io.cozy.tasks', id: 1 },
-      { doctype: 'io.cozy.tasks', id: 2 }
-    ])
+    it('adds by multiple docs', () => {
+      hydrated.tasks.add([{ _id: 4 }, { _id: 5 }])
+      expect(hydrated.tasks.data).toEqual([
+        { doctype: 'io.cozy.tasks', id: 1 },
+        { doctype: 'io.cozy.tasks', id: 2 },
+        { doctype: 'io.cozy.tasks', id: 4 },
+        { doctype: 'io.cozy.tasks', id: 5 }
+      ])
+    })
   })
 
-  it('can remove multiple docs from the relationship', () => {
-    hydrated.tasks.removeById([1, 2])
-    expect(hydrated.tasks.data).toEqual([])
+  describe('remove', () => {
+    it('removes by id', () => {
+      hydrated.tasks.removeById(2)
+      expect(hydrated.tasks.data).toEqual([{ doctype: 'io.cozy.tasks', id: 1 }])
+      expect(save).toHaveBeenCalled()
+    })
+
+    it('doesnt remove if not there', () => {
+      hydrated.tasks.removeById(3)
+      expect(hydrated.tasks.data).toEqual([
+        { doctype: 'io.cozy.tasks', id: 1 },
+        { doctype: 'io.cozy.tasks', id: 2 }
+      ])
+    })
+
+    it('can remove multiple docs from the relationship', () => {
+      hydrated.tasks.removeById([1, 2])
+      expect(hydrated.tasks.data).toEqual([])
+    })
+
+    it('remove by doc', () => {
+      hydrated.tasks.remove({ _id: 2 })
+      expect(hydrated.tasks.data).toEqual([{ doctype: 'io.cozy.tasks', id: 1 }])
+      expect(save).toHaveBeenCalled()
+    })
+
+    it('remove by docs', () => {
+      hydrated.tasks.remove([{ _id: 1 }, { _id: 2 }])
+      expect(hydrated.tasks.data).toEqual([])
+      expect(save).toHaveBeenCalled()
+    })
   })
 
   it('updates the count metadata', () => {

package/dist/associations/HasOne.js

@@ -21,7 +21,7 @@ var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/ge
 
 var _get2 = _interopRequireDefault(require("lodash/get"));
 
-var _set2 = _interopRequireDefault(require("lodash/set"));
+var _set = _interopRequireDefault(require("lodash/set"));
 
 var _dsl = require("../queries/dsl");
 
@@ -48,8 +48,33 @@ var HasOne = /*#__PURE__*/function (_Association) {
   }
 
   (0, _createClass2.default)(HasOne, [{
-    key: "set",
-    value: function set(doc) {
+    key: "add",
+
+    /**
+     * Add the relationship to the target document
+     *
+     * @param {CozyClientDocument} doc - Document to add as a relationship
+     * @returns {CozyClientDocument} The saved target document
+     */
+    value: function add(doc) {
+      this.setRelationship(doc);
+      return this.save(this.target);
+    }
+    /**
+     * Remove the relationship from the target document
+     *
+     * @returns {CozyClientDocument} The saved target document
+     */
+
+  }, {
+    key: "remove",
+    value: function remove() {
+      this.setRelationship(undefined);
+      return this.save(this.target);
+    }
+  }, {
+    key: "setRelationship",
+    value: function setRelationship(doc) {
       if (doc && doc._type !== this.doctype) {
         throw new Error("Tried to associate a ".concat(doc._type, " document to a HasOne relationship on ").concat(this.doctype, " document"));
       }
@@ -57,18 +82,25 @@ var HasOne = /*#__PURE__*/function (_Association) {
       var path = "relationships[".concat(this.name, "].data");
 
       if (doc) {
-        (0, _set2.default)(this.target, path, {
+        (0, _set.default)(this.target, path, {
           _id: doc._id,
           _type: doc._type
         });
       } else {
-        (0, _set2.default)(this.target, path, undefined);
+        (0, _set.default)(this.target, path, undefined);
       }
     }
+  }, {
+    key: "set",
+    value: function set(doc) {
+      console.warn('set is deprecated for has-one relationships. Use `add` instead.');
+      this.setRelationship(doc);
+    }
   }, {
     key: "unset",
     value: function unset() {
-      this.set(undefined);
+      console.warn('unset is deprecated for has-one relationships. Use `remove` instead.');
+      this.setRelationship(undefined);
     }
   }, {
     key: "dehydrate",

package/dist/associations/HasOne.spec.js

@@ -28,14 +28,16 @@ const fixtures = {
 const hydratedMaster = {
   ...fixtures.jediMaster,
   padawan: new HasOne(fixtures.jediMaster, 'padawan', 'io.cozy.jedis', {
-    get: jest.fn().mockReturnValue(fixtures.apprentice)
+    get: jest.fn().mockReturnValue(fixtures.apprentice),
+    save: jest.fn()
   })
 }
 
 const hydratedApprentice = {
   ...fixtures.apprentice,
   padawan: new HasOne(fixtures.apprentice, 'padawan', 'io.cozy.jedis', {
-    get: jest.fn().mockReturnValue(undefined)
+    get: jest.fn().mockReturnValue(undefined),
+    save: jest.fn()
   })
 }
 
@@ -101,10 +103,13 @@ describe('HasOne', () => {
     })
   })
 
-  describe('set', () => {
+  describe('setRelationship', () => {
     it("should throw if the document to be set's type is not the same as the association type", () => {
       expect(() =>
-        hydratedMaster.padawan.set({ _id: '1', _type: 'io.cozy.stuff' })
+        hydratedMaster.padawan.setRelationship({
+          _id: '1',
+          _type: 'io.cozy.stuff'
+        })
       ).toThrow()
     })
 
@@ -115,7 +120,7 @@ describe('HasOne', () => {
         name: 'Bernard Nobody'
       }
 
-      hydratedMaster.padawan.set(newPadawan)
+      hydratedMaster.padawan.setRelationship(newPadawan)
 
       expect(hydratedMaster.padawan.raw).toEqual({
         _id: newPadawan._id,
@@ -123,4 +128,23 @@ describe('HasOne', () => {
       })
     })
   })
+
+  describe('remove', () => {
+    it('should remove', () => {
+      hydratedMaster.padawan.remove()
+      expect(hydratedMaster.padawan.raw).toEqual(null)
+    })
+  })
+
+  describe('add', () => {
+    it('should add', () => {
+      hydratedMaster.padawan.remove()
+      hydratedMaster.padawan.add({ _id: 'luke', _type: 'io.cozy.jedis' })
+
+      expect(hydratedMaster.padawan.raw).toEqual({
+        _type: 'io.cozy.jedis',
+        _id: 'luke'
+      })
+    })
+  })
 })

package/dist/store/documents.js

@@ -184,21 +184,7 @@ var extractAndMergeDocument = function extractAndMergeDocument(data, updatedStat
   }
 
   var sortedData = (0, _keyBy.default)(data, _helpers.properId);
-  var mergedData = {};
-
-  if (updatedStateWithIncluded && updatedStateWithIncluded[doctype]) {
-    Object.values(updatedStateWithIncluded[doctype]).map(function (dataState) {
-      if (!mergedData[doctype]) mergedData[doctype] = {};
-      var id = (0, _helpers.properId)(dataState);
-
-      if (sortedData[id]) {
-        mergedData[doctype][id] = _objectSpread(_objectSpread(_objectSpread({}, dataState), sortedData[id]), mergedData[doctype][id]);
-      } else {
-        mergedData[doctype][id] = _objectSpread(_objectSpread({}, dataState), mergedData[doctype][id]);
-      }
-    });
-  }
-
+  var mergedData = Object.assign({}, updatedStateWithIncluded);
   Object.values(sortedData).map(function (data) {
     if (!mergedData[doctype]) mergedData[doctype] = {};
     var id = (0, _helpers.properId)(data);
@@ -209,7 +195,7 @@ var extractAndMergeDocument = function extractAndMergeDocument(data, updatedStat
       mergedData[doctype][id] = data;
     }
   });
-  return _objectSpread(_objectSpread({}, updatedStateWithIncluded), mergedData);
+  return mergedData;
 };
 
 exports.extractAndMergeDocument = extractAndMergeDocument;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "24.6.0",
+  "version": "24.8.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -21,19 +21,19 @@
     "cozy-device-helper": "^1.12.0",
     "cozy-flags": "2.7.1",
     "cozy-logger": "^1.6.0",
-    "cozy-stack-client": "^24.6.0",
+    "cozy-stack-client": "^24.6.1",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.13",
     "microee": "^0.0.6",
     "node-fetch": "^2.6.1",
-    "open": "^7.0.2",
+    "open": "^8.0.0",
     "prop-types": "^15.6.2",
     "react-redux": "^7.2.0",
     "redux": "3 || 4",
     "redux-thunk": "^2.3.0",
     "server-destroy": "^1.0.1",
     "sift": "^6.0.0",
-    "url-search-params-polyfill": "^7.0.0"
+    "url-search-params-polyfill": "^8.0.0"
   },
   "scripts": {
     "build": "../../bin/build",
@@ -49,7 +49,7 @@
     "@testing-library/react-hooks": "^3.2.1",
     "babel-plugin-search-and-replace": "1.1.0",
     "btoa": "^1.2.1",
-    "cozy-logger": "^1.6.0",
+    "cozy-logger": "1.7.0",
     "cozy-ui": "48.0.0",
     "date-fns": "2.19.0",
     "jsdoc-plugin-intersection": "^1.0.4",
@@ -57,16 +57,16 @@
     "react": "16.14.0",
     "react-inspector": "5.1.1",
     "react-redux": "7.2.4",
-    "react-test-renderer": "^16.12.0",
+    "react-test-renderer": "16.14.0",
     "server-destroy": "^1.0.1",
     "typescript": "^4.1.5"
   },
   "peerDependencies": {
     "cozy-ui": ">34.0.0",
     "react": "^16.7.0",
-    "react-native": "^0.64.1",
+    "react-native": "^0.65.0",
     "react-native-inappbrowser-reborn": "^3.5.1"
   },
   "sideEffects": false,
-  "gitHead": "3a68634bf0b13cf4f4ae138681f47ddebe433cec"
+  "gitHead": "eb10dd8e450275b8ad3d10ae33f35c1e57e76bc4"
 }

package/types/associations/HasMany.d.ts

@@ -87,6 +87,20 @@ declare class HasMany extends Association {
     exists(document: any): boolean;
     containsById(id: any): boolean;
     existsById(id: any): boolean;
+    /**
+     * Add the relationships to the target document
+     *
+     * @param {CozyClientDocument[]} docsArg - Documents to add as relationships
+     * @returns {CozyClientDocument} The saved target document
+     */
+    add(docsArg: CozyClientDocument[]): CozyClientDocument;
+    /**
+     * Remove the relationships from the target document
+     *
+     * @param {CozyClientDocument[]} docsArg - Documents to remove as relationships
+     * @returns {CozyClientDocument} The saved target document
+     */
+    remove(docsArg: CozyClientDocument[]): CozyClientDocument;
     /**
      * Add a referenced document by id. You need to call save()
      * in order to synchronize your document with the store.
@@ -106,3 +120,4 @@ declare class HasMany extends Association {
     dehydrate(doc: any): any;
 }
 import Association from "./Association";
+import { CozyClientDocument } from "../types";

package/types/associations/HasOne.d.ts

@@ -6,8 +6,23 @@ export default class HasOne extends Association {
         save: Function;
         dispatch: Function;
     });
+    /**
+     * Add the relationship to the target document
+     *
+     * @param {CozyClientDocument} doc - Document to add as a relationship
+     * @returns {CozyClientDocument} The saved target document
+     */
+    add(doc: CozyClientDocument): CozyClientDocument;
+    /**
+     * Remove the relationship from the target document
+     *
+     * @returns {CozyClientDocument} The saved target document
+     */
+    remove(): CozyClientDocument;
+    setRelationship(doc: any): void;
     set(doc: any): void;
     unset(): void;
     dehydrate(doc: any): any;
 }
 import Association from "./Association";
+import { CozyClientDocument } from "../types";