cozy-client 59.3.0 → 60.0.0

package/dist/CozyClient.js

@@ -152,7 +152,7 @@ var DOC_UPDATE = 'update';
  * @property {string} [uri]
  * @property {object} [stackClient]
  * @property {boolean} [warningForCustomHandlers]
- * @property {boolean} [autoHydrate]
+ * @property {boolean} [autoHydrate] - If set to true, all documents will be hydrated w.r.t. the provided schema's relationships, even if the relationship does not exist on the doc.
  * @property {boolean} [backgroundFetching] - If set to true, backgroundFetching will be enabled by default on every query. Meaning that, when the fetchStatus has already been loaded, it won't be updated during future fetches. Instead, a `isFetching` attribute will be used to indicate when background fetching is started.
  * @property {object} [oauth]
  * @property {Function} [onTokenRefresh]
@@ -163,8 +163,7 @@ var DOC_UPDATE = 'update';
  * @property  {import("./types").AppMetadata}  [appMetadata] - Metadata about the application that will be used in ensureCozyMetadata
  * @property  {import("./types").ClientCapabilities} [capabilities] - Capabilities sent by the stack
  * @property  {boolean} [useCustomStore=false] - If set to true, the client will not instantiate a Redux store automatically. Use this if you want to merge cozy-client's store with your own redux store. Note will have to call `setStore` eventually. See [here](https://docs.cozy.io/en/cozy-client/react-integration/#1b-use-your-own-redux-store) for more information.
- * @property  {boolean} [disableStoreForQueries=false] - If set to true, the client will not leverage the redux store to execute queries and store data. 
- 
+ * @property  {boolean} [disableStoreForQueries=false] - If set to true, the client will not leverage the redux store to execute queries and store data.
  * @property {import('./performances/types').PerformanceAPI} [performanceApi] - The performance API that can be used to measure performances
  */
 
@@ -317,6 +316,7 @@ var CozyClient = /*#__PURE__*/function () {
       this.ensureStore();
     }
 
+    this.autoHydrate = _options.autoHydrate || false;
     this.disableStoreForQueries = _options.disableStoreForQueries || false;
   }
   /**
@@ -2017,7 +2017,7 @@ var CozyClient = /*#__PURE__*/function () {
                       if (queryDef instanceof _dsl.QueryDefinition) {
                         definitions.push(queryDef);
                       } else {
-                        documents.push(queryDef);
+                        documents.push(doc);
                       }
                     } catch (_unused) {// eslint-disable-next-line
                       // We do not crash completely if one the relationship behaves badly and
@@ -2159,10 +2159,6 @@ var CozyClient = /*#__PURE__*/function () {
     value: function hydrateDocuments(doctype, documents) {
       var _this8 = this;
 
-      if (this.options.autoHydrate === false) {
-        return documents;
-      }
-
       var schema = this.schema.getDoctypeSchema(doctype);
       var relationships = schema.relationships;
 
@@ -2193,29 +2189,22 @@ var CozyClient = /*#__PURE__*/function () {
       }
 
       var schema = schemaArg || this.schema.getDoctypeSchema(document._type);
-      return _objectSpread(_objectSpread({}, document), this.hydrateRelationships(document, schema.relationships));
+      var hydratedRelationships = this.hydrateRelationships(document, schema.relationships);
+      return _objectSpread(_objectSpread({}, document), hydratedRelationships);
     }
   }, {
     key: "hydrateRelationships",
     value: function hydrateRelationships(document, schemaRelationships) {
+      var _this9 = this;
+
       var methods = this.getRelationshipStoreAccessors();
       return (0, _mapValues.default)(schemaRelationships, function (assoc, name) {
-        return (0, _associations.create)(document, assoc, methods);
-      });
-    }
-    /**
-     * Creates (locally) a new document for the given doctype.
-     * This document is hydrated : its relationships are there
-     * and working.
-     */
+        var _this9$options, _document$relationshi;
 
-  }, {
-    key: "makeNewDocument",
-    value: function makeNewDocument(doctype) {
-      var obj = {
-        _type: doctype
-      };
-      return this.hydrateDocument(obj);
+        if ((_this9$options = _this9.options) !== null && _this9$options !== void 0 && _this9$options.autoHydrate || (_document$relationshi = document.relationships) !== null && _document$relationshi !== void 0 && _document$relationshi[name]) {
+          return (0, _associations.create)(document, assoc, methods);
+        }
+      });
     }
   }, {
     key: "generateRandomId",
@@ -2243,20 +2232,20 @@ var CozyClient = /*#__PURE__*/function () {
   }, {
     key: "getRelationshipStoreAccessors",
     value: function getRelationshipStoreAccessors() {
-      var _this9 = this;
+      var _this10 = this;
 
       if (!this.storeAccesors) {
         this.storeAccessors = {
           get: this.getDocumentFromState.bind(this),
           save: function save(document, opts) {
-            return _this9.save.call(_this9, document, opts);
+            return _this10.save.call(_this10, document, opts);
           },
           dispatch: this.dispatch.bind(this),
           query: function query(def, opts) {
-            return _this9.query.call(_this9, def, opts);
+            return _this10.query.call(_this10, def, opts);
           },
           mutate: function mutate(def, opts) {
-            return _this9.mutate.call(_this9, def, opts);
+            return _this10.mutate.call(_this10, def, opts);
           }
         };
       }
@@ -2307,7 +2296,7 @@ var CozyClient = /*#__PURE__*/function () {
      *
      * @param {string} id - Id of the query (set via Query.props.as)
      * @param {object} options - Options
-     * @param {boolean} [options.hydrated] - Whether documents should be returned already hydrated (default: false)
+     * @param {boolean} [options.hydrated] - Whether documents should be returned already hydrated
      * @param  {object} [options.singleDocData] - If true, the "data" returned will be
      * a single doc instead of an array for single doc queries. Defaults to false for backward
      * compatibility but will be set to true in the future.
@@ -2319,22 +2308,33 @@ var CozyClient = /*#__PURE__*/function () {
     key: "getQueryFromState",
     value: function getQueryFromState(id) {
       var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-      var hydrated = options.hydrated || false;
-      var singleDocData = options.singleDocData || false;
+      var singleDocData = options.singleDocData || false; // `hydrated` has priority over global `autoHydrate`
+
+      var shouldHydrate = options.hydrated !== undefined ? options.hydrated : this.options.autoHydrate;
 
       try {
+        var _this$schema$getDocty;
+
         var queryResults = (0, _store.getQueryFromState)(this.store.getState(), id);
         var doctype = queryResults.definition && queryResults.definition.doctype;
         var isSingleDocQuery = queryResults.definition && queryResults.definition.id;
 
-        if (!hydrated && !singleDocData) {
+        if (!shouldHydrate && !singleDocData) {
           // Early return let's us preserve reference equality in the simple case
           return queryResults;
         }
 
-        var data = hydrated && doctype ? this.hydrateDocuments(doctype, queryResults.data) : queryResults.data;
+        var hydratedData = shouldHydrate && doctype ? this.hydrateDocuments(doctype, queryResults.data) : queryResults.data;
+        var relationships = (_this$schema$getDocty = this.schema.getDoctypeSchema(doctype)) === null || _this$schema$getDocty === void 0 ? void 0 : _this$schema$getDocty.relationships;
+        var relationshipNames = relationships ? Object.keys(relationships) : null; // The `data` array contains the hydrated data with the relationships, if any.
+        // The `storeData` array contains the documents from the store: this is useful to preserve
+        // referential equality, to be later evaluated to determine whether or not the
+        // documents had changed.
+
         return _objectSpread(_objectSpread({}, queryResults), {}, {
-          data: isSingleDocQuery && singleDocData ? data[0] : data
+          data: isSingleDocQuery && singleDocData ? hydratedData[0] : hydratedData,
+          storeData: isSingleDocQuery && singleDocData ? queryResults.data[0] : queryResults.data,
+          relationshipNames: relationshipNames
         });
       } catch (e) {
         _logger.default.warn("Could not get query from state. queryId: ".concat(id, ", error: ").concat(e.message));
@@ -2838,7 +2838,7 @@ var CozyClient = /*#__PURE__*/function () {
   }, {
     key: "setData",
     value: function setData(data) {
-      var _this10 = this;
+      var _this11 = this;
 
       this.ensureStore();
       Object.entries(data).forEach(function (_ref9) {
@@ -2846,7 +2846,7 @@ var CozyClient = /*#__PURE__*/function () {
             doctype = _ref10[0],
             data = _ref10[1];
 
-        _this10.dispatch((0, _store.receiveQueryResult)(null, {
+        _this11.dispatch((0, _store.receiveQueryResult)(null, {
           data: data
         }));
       });
@@ -3264,7 +3264,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 = "59.3.0";
+CozyClient.version = "60.0.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/CozyClient.spec.js

@@ -11,7 +11,8 @@ import {
   APP_VERSION,
   SOURCE_ACCOUNT_ID,
   SOURCE_ACCOUNT_IDENTIFIER,
-  FILE_1
+  FILE_1,
+  TODO_WITH_NONEXISTING_RELATIONSHIP
 } from './__tests__/fixtures'
 import { withIgnoreConsoleWarn } from './__tests__/console'
 
@@ -34,7 +35,7 @@ import {
   resetQuery,
   executeQueryFromState
 } from './store'
-import { HasManyFiles, Association, HasMany } from './associations'
+import { HasManyFiles, Association } from './associations'
 import mapValues from 'lodash/mapValues'
 import FileCollection from 'cozy-stack-client/dist/FileCollection'
 import logger from './logger'
@@ -1016,7 +1017,16 @@ describe('CozyClient', () => {
       const NEW_TODO = {
         _type: 'io.cozy.todos',
         label: 'Buy RAM',
-        attachments: [{ _id: 12345, _type: 'io.cozy.files' }]
+        relationships: {
+          attachments: {
+            data: [
+              {
+                _type: 'io.cozy.files',
+                _id: 1
+              }
+            ]
+          }
+        }
       }
       const EXPECTED_CREATED_TODO = { _id: 67890, ...NEW_TODO }
       const mutation = client.getDocumentSavePlan(NEW_TODO, {
@@ -1040,9 +1050,14 @@ describe('CozyClient', () => {
             id: 67890,
             type: 'io.cozy.files'
           }
-        ]
+        ],
+        relationships: { icons: [{ _id: 67890, _type: 'io.cozy.files' }] }
+      }
+      const EXPECTED_CREATED_FILE = {
+        _id: 12345,
+        _type: 'io.cozy.files',
+        relationships: { icons: [{ _id: 67890, _type: 'io.cozy.files' }] }
       }
-      const EXPECTED_CREATED_FILE = { _id: 12345, _type: 'io.cozy.files' }
       const mutation = client.getDocumentSavePlan(NEW_FILE, {
         icons: [
           {
@@ -1907,14 +1922,6 @@ describe('CozyClient', () => {
         )
         .shift()
       expect(doc.attachments).toBeInstanceOf(HasManyFiles)
-      expect(doc.authors).toBeInstanceOf(HasMany)
-    })
-
-    it('makes new documents', () => {
-      const newTodo = client.makeNewDocument('io.cozy.todos')
-      expect(newTodo._type).toBe('io.cozy.todos')
-      expect(newTodo.attachments).not.toBe(undefined)
-      expect(newTodo.attachments instanceof HasManyFiles).toBe(true)
     })
 
     it('should not fail on null (when getting absent documents from the store)', () => {
@@ -1923,6 +1930,53 @@ describe('CozyClient', () => {
         .shift()
       expect(doc).toBe(null)
     })
+
+    it('should hydrate relationships if the relationship exists', () => {
+      const resp = client.hydrateDocument(TODO_WITH_AUTHOR)
+      expect(resp.authors).not.toBe(undefined)
+      expect(resp.attachments).toBe(undefined)
+    })
+
+    it('should not hydrate relationships if the relationship does not exist', () => {
+      const resp = client.hydrateDocument(TODO_WITH_NONEXISTING_RELATIONSHIP)
+      expect(resp.authors).toBe(undefined)
+      expect(resp.attachments).toBe(undefined)
+      expect(resp.broken).toBe(undefined)
+    })
+
+    it('should not hydrate relationships if not specified', () => {
+      getQueryFromState.mockReturnValueOnce({
+        definition: { doctype: 'io.cozy.todos' },
+        data: [TODO_WITH_AUTHOR]
+      })
+      const resp = client.getQueryFromState('allTodos')
+      expect(resp.data[0].authors).toBe(undefined)
+      expect(resp.data[0].attachments).toBe(undefined)
+    })
+
+    it('should hydrate relationships only if the relationship does exist ', () => {
+      getQueryFromState.mockReturnValueOnce({
+        definition: { doctype: 'io.cozy.todos' },
+        data: [TODO_WITH_AUTHOR]
+      })
+      const resp = client.getQueryFromState('allTodos', { hydrated: true })
+      expect(resp.data[0].authors).not.toBe(undefined)
+      expect(resp.data[0].attachments).toBe(undefined)
+    })
+
+    it('should hydrate relationships if the relationship does not exist but hydration is forced', () => {
+      const newClient = new CozyClient({
+        schema: SCHEMA,
+        autoHydrate: true
+      })
+      getQueryFromState.mockReturnValueOnce({
+        definition: { doctype: 'io.cozy.todos' },
+        data: [TODO_WITH_AUTHOR]
+      })
+      const resp = newClient.getQueryFromState('allTodos')
+      expect(resp.data[0].authors).not.toBe(undefined)
+      expect(resp.data[0].attachments).not.toBe(undefined)
+    })
   })
 
   describe('serialization', () => {
@@ -2122,7 +2176,8 @@ describe('file creation', () => {
       .fn()
       .mockResolvedValueOnce({
         data: {
-          _id: '1337'
+          _id: '1337',
+          relationships: { icons: [{ _id: 1, _type: 'io.cozy.files' }] }
         }
       })
       .mockResolvedValueOnce({

package/dist/Query.spec.jsx

@@ -195,6 +195,8 @@ describe('Query', () => {
           count: 0,
           fetchedPagesCount: 0,
           data: [],
+          storeData: [],
+          relationshipNames: null,
           definition: { doctype: 'io.cozy.todos' },
           fetch: expect.any(Function),
           fetchMore: expect.any(Function),

package/dist/__tests__/fixtures.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.SCHEMA = exports.SOURCE_ACCOUNT_IDENTIFIER = exports.SOURCE_ACCOUNT_ID = exports.DOCTYPE_VERSION = exports.APP_VERSION = exports.APP_NAME = exports.FILE_2 = exports.FILE_1 = exports.TODO_WITH_AUTHOR = exports.AUTHORS = exports.TODO_WITH_RELATION = exports.TODOS = exports.TODO_4 = exports.TODO_3 = exports.TODO_2 = exports.TODO_1 = void 0;
+exports.SCHEMA = exports.SOURCE_ACCOUNT_IDENTIFIER = exports.SOURCE_ACCOUNT_ID = exports.DOCTYPE_VERSION = exports.APP_VERSION = exports.APP_NAME = exports.FILE_2 = exports.FILE_1 = exports.TODO_WITH_NONEXISTING_RELATIONSHIP = exports.TODO_WITH_AUTHOR = exports.AUTHORS = exports.TODO_WITH_RELATION = exports.TODOS = exports.TODO_4 = exports.TODO_3 = exports.TODO_2 = exports.TODO_1 = void 0;
 var TODO_1 = {
   _id: 'todo_1',
   _rev: '4-43bdf4f7123f4d748645ba9536a46daa',
@@ -88,6 +88,22 @@ var TODO_WITH_AUTHOR = {
   }
 };
 exports.TODO_WITH_AUTHOR = TODO_WITH_AUTHOR;
+var TODO_WITH_NONEXISTING_RELATIONSHIP = {
+  _id: 5,
+  _rev: '1-7f02bbb542fb4eb0805b130a80b9be1a',
+  _type: 'io.cozy.todos',
+  label: 'Todo with several authors',
+  relationships: {
+    broken: {
+      doctype: 'io.cozy.persons',
+      data: [{
+        _type: 'io.cozy.persons',
+        _id: 1
+      }]
+    }
+  }
+};
+exports.TODO_WITH_NONEXISTING_RELATIONSHIP = TODO_WITH_NONEXISTING_RELATIONSHIP;
 var FILE_1 = {
   _id: 1,
   _rev: '3-bd9bb7286a094842b954d9e86429090d',

package/dist/hooks/useQuery.js

@@ -25,6 +25,8 @@ var _context = require("../context");
 
 var _dsl = require("../queries/dsl");
 
+var _selector = require("../store/selector");
+
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
@@ -83,7 +85,7 @@ var useQuery = function useQuery(queryDefinition, options) {
       hydrated: (0, _get.default)(options, 'hydrated', true),
       singleDocData: (0, _get.default)(options, 'singleDocData', false)
     });
-  });
+  }, _selector.equalityCheckForQuery);
   (0, _react.useEffect)(function () {
     if (enabled === false) {
       return;

package/dist/hooks/useQuery.spec.jsx

@@ -107,7 +107,7 @@ describe('use query', () => {
     })
 
     expect(Object.keys(current)).toEqual(
-      expect.objectContaining([
+      expect.arrayContaining([
         'id',
         'definition',
         'fetchStatus',
@@ -120,6 +120,8 @@ describe('use query', () => {
         'count',
         'fetchedPagesCount',
         'data',
+        'storeData',
+        'relationshipNames',
         'bookmark',
         'options',
         'fetchMore',

package/dist/store/__snapshots__/queries.spec.js.snap

@@ -32,6 +32,8 @@ Object {
     "lastFetch": null,
     "lastUpdate": null,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;
@@ -71,6 +73,8 @@ Object {
     "lastFetch": 1337,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;
@@ -109,6 +113,8 @@ Object {
     "lastFetch": 1337,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
   "b": Object {
     "bookmark": null,
@@ -147,6 +153,8 @@ Object {
     "lastFetch": null,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;
@@ -185,6 +193,8 @@ Object {
     "lastFetch": 1337,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
   "b": Object {
     "bookmark": null,
@@ -220,6 +230,8 @@ Object {
     "lastFetch": null,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;
@@ -264,6 +276,8 @@ Object {
     "lastFetch": 1337,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
   "b": Object {
     "bookmark": null,
@@ -297,6 +311,8 @@ Object {
     "lastFetch": null,
     "lastUpdate": null,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;
@@ -336,6 +352,8 @@ Object {
     "lastFetch": 1337,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
   "b": Object {
     "bookmark": null,
@@ -370,6 +388,8 @@ Object {
     "lastFetch": null,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;
@@ -408,6 +428,8 @@ Object {
     "lastFetch": 1337,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
   "b": Object {
     "bookmark": null,
@@ -445,6 +467,8 @@ Object {
         "add": false,
       },
     },
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;
@@ -481,6 +505,8 @@ Object {
     "lastFetch": null,
     "lastUpdate": null,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
   "b": Object {
     "bookmark": null,
@@ -512,6 +538,8 @@ Object {
     "lastFetch": 1337,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;
@@ -550,6 +578,8 @@ Object {
     "lastFetch": 1337,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
   "b": Object {
     "bookmark": null,
@@ -589,6 +619,8 @@ Object {
         "remove": false,
       },
     },
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;
@@ -627,6 +659,8 @@ Object {
     "lastFetch": 1337,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
   "b": Object {
     "bookmark": null,
@@ -660,6 +694,8 @@ Object {
     "lastFetch": null,
     "lastUpdate": null,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;
@@ -700,6 +736,8 @@ Object {
     "lastFetch": 1337,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
   "b": Object {
     "bookmark": null,
@@ -736,6 +774,8 @@ Object {
     "lastFetch": null,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;

package/dist/store/queries.js

@@ -94,7 +94,9 @@ var queryInitialState = {
   count: 0,
   fetchedPagesCount: 0,
   data: [],
-  bookmark: null
+  storeData: [],
+  bookmark: null,
+  relationshipNames: []
 };
 /**
  * Return the docs ids accordingly to the given sort and fetched docs

package/dist/store/selector.js

@@ -0,0 +1,138 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.equalityCheckForQuery = void 0;
+
+function _createForOfIteratorHelper(o, allowArrayLike) { var it; if (typeof Symbol === "undefined" || o[Symbol.iterator] == null) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = o[Symbol.iterator](); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+/**
+ * Perform an equality check to determine whether or not two query results are equal.
+ *
+ * This is typically called by a `useSelector`, to determine if a render should be made because
+ * the query result has changed.
+ * See https://react-redux.js.org/api/hooks#equality-comparisons-and-updates
+ *
+ * We cannot use the default strict reference comparison here, because a new reference for the query
+ * result is made every time. However, the query result itself, in `storeData`, preserves references.
+ *
+ * Note we do not make a shallow equality check on documents, as it is much less efficient.
+ * It is however different for relationships: because of their hydratation, the references change
+ * even if the data is the same.
+ *
+ * @param {import("../types").QueryState} queryResA - A query result to compare
+ * @param {import("../types").QueryState} queryResB - A query result to compare
+ * @returns {boolean} whether or not the two query are equal
+ */
+var equalityCheckForQuery = function equalityCheckForQuery(queryResA, queryResB) {
+  if (queryResA === queryResB) {
+    // Referential equality
+    return true;
+  }
+
+  if (typeof queryResA !== 'object' || queryResA === null || typeof queryResB !== 'object' || queryResB === null) {
+    // queryResA or queryResB is not an object or null
+    return false;
+  }
+
+  if (queryResA.id !== queryResB.id) {
+    return false;
+  }
+
+  if (queryResA.fetchStatus !== queryResB.fetchStatus) {
+    return false;
+  }
+
+  var docsA = queryResA.storeData;
+  var docsB = queryResB.storeData;
+
+  if (!docsA || !docsB) {
+    // No data to check
+    return false;
+  }
+
+  if (!Array.isArray(docsA) && !Array.isArray(docsB) && docsA !== docsB) {
+    // Only one doc
+    return false;
+  }
+
+  if (Array.isArray(docsA) && Array.isArray(docsB) && !arraysHaveSameLength(docsA, docsB)) {
+    // A document was added or removed
+    return false;
+  }
+
+  if (Array.isArray(docsA) && Array.isArray(docsB)) {
+    for (var i = 0; i < docsA.length; i++) {
+      if (docsA[i] !== docsB[i]) {
+        // References should be the same for non-updated documents
+        return false;
+      }
+    }
+  }
+
+  if (queryResA.relationshipNames) {
+    // In case of relationships, we cannot check referential equality, because we
+    // "hydrate" the data by creating a new instance of the related relationship class.
+    // Thus, we check the document revision instead.
+    var hydratedDataA = queryResA.data;
+    var hydratedDataB = queryResB.data;
+
+    if (!Array.isArray(hydratedDataA) && !Array.isArray(hydratedDataB)) {
+      // One doc with changed relationship
+      return revsAreEqual(hydratedDataA, hydratedDataB);
+    }
+
+    if (!arraysHaveSameLength(hydratedDataA, hydratedDataB)) {
+      // A relationship have been added or removed
+      return false;
+    }
+
+    if (Array.isArray(hydratedDataA) && Array.isArray(hydratedDataB)) {
+      for (var _i = 0; _i < hydratedDataA.length; _i++) {
+        var _iterator = _createForOfIteratorHelper(queryResA.relationshipNames),
+            _step;
+
+        try {
+          for (_iterator.s(); !(_step = _iterator.n()).done;) {
+            var name = _step.value;
+            // Check hydrated relationship
+            var includedA = hydratedDataA[_i][name];
+            var includedB = hydratedDataB[_i][name];
+
+            if (includedA && includedB) {
+              if (!revsAreEqual(includedA, includedB)) {
+                return false;
+              }
+            }
+          }
+        } catch (err) {
+          _iterator.e(err);
+        } finally {
+          _iterator.f();
+        }
+      }
+    }
+  } // The query results are indeed equal
+
+
+  return true;
+};
+
+exports.equalityCheckForQuery = equalityCheckForQuery;
+
+var revsAreEqual = function revsAreEqual(docA, docB) {
+  if (!docA._rev || !docB._rev) {
+    return false;
+  }
+
+  return (docA === null || docA === void 0 ? void 0 : docA._rev) === (docB === null || docB === void 0 ? void 0 : docB._rev);
+};
+
+var arraysHaveSameLength = function arraysHaveSameLength(arrayA, arrayB) {
+  return Array.isArray(arrayA) && Array.isArray(arrayB) && arrayA.length === arrayB.length;
+};

package/dist/store/selector.spec.js

@@ -0,0 +1,238 @@
+import { equalityCheckForQuery } from './selector'
+
+const mapIdsToDocuments = (state, doctype, ids) => {
+  return ids.map(id => state[doctype][id])
+}
+
+const state = {
+  documents: {
+    'io.cozy.files': {
+      doc1: {
+        _id: 'doc1'
+      },
+      doc2: {
+        _id: 'doc2'
+      },
+      doc3: {
+        _id: 'doc3'
+      }
+    }
+  },
+  queries: {
+    query1: {
+      id: 'query1',
+      data: ['doc1', 'doc2']
+    },
+    query2: {
+      id: 'query2',
+      data: ['doc2']
+    }
+  }
+}
+
+const defaultQueryResult = {
+  id: 1,
+  data: [],
+  fetchStatus: 'loaded',
+  relationshipNames: null
+}
+
+describe('equalityCheckForQuery', () => {
+  const queryResultA1 = {
+    id: 1,
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', [
+      'doc1',
+      'doc2'
+    ]),
+    ...defaultQueryResult
+  }
+  const queryResultA2 = {
+    id: 1,
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', [
+      'doc1',
+      'doc2'
+    ]),
+    ...defaultQueryResult
+  }
+  const queryResultA3 = {
+    id: 1,
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', [
+      'doc1',
+      'doc2',
+      'doc3'
+    ]),
+    ...defaultQueryResult
+  }
+  const queryResultA4 = {
+    id: 1,
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', [
+      'doc2',
+      'doc3'
+    ]),
+    ...defaultQueryResult
+  }
+  const queryResultB1 = {
+    id: 2,
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', ['doc2']),
+    ...defaultQueryResult
+  }
+
+  const queryResultB2 = {
+    id: 2,
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', ['doc3']),
+    ...defaultQueryResult
+  }
+
+  const queryResultC1 = {
+    id: 3,
+    storeData: state.documents['io.cozy.files'].doc1,
+    data: {},
+    ...defaultQueryResult
+  }
+
+  const queryResultC2 = {
+    id: 3,
+    storeData: state.documents['io.cozy.files'].doc1,
+    data: {},
+    ...defaultQueryResult
+  }
+
+  const queryResultC3 = {
+    id: 3,
+    storeData: state.documents['io.cozy.files'].doc2,
+    data: {},
+    ...defaultQueryResult
+  }
+
+  it('should return true for referential equality', () => {
+    expect(equalityCheckForQuery(queryResultA1, queryResultA1)).toBe(true)
+    expect(equalityCheckForQuery(null, null)).toBe(true)
+  })
+
+  it('should return false if one object is null', () => {
+    expect(equalityCheckForQuery(null, queryResultA1)).toBe(false)
+    expect(equalityCheckForQuery(queryResultA1, null)).toBe(false)
+  })
+
+  it('should return false if one or both objects are not objects', () => {
+    // @ts-ignore
+    expect(equalityCheckForQuery('notAnObject', queryResultA1)).toBe(false)
+    // @ts-ignore
+    expect(equalityCheckForQuery(queryResultA1, 'notAnObject')).toBe(false)
+  })
+
+  it('should return false if `id` properties are different', () => {
+    expect(equalityCheckForQuery(queryResultA1, queryResultB1)).toBe(false)
+  })
+
+  it('should return false if one or both objects lack `data`', () => {
+    // @ts-ignore
+    expect(equalityCheckForQuery({ id: 1 }, queryResultA1)).toBe(false)
+    // @ts-ignore
+    expect(equalityCheckForQuery(queryResultA1, { id: 1 })).toBe(false)
+  })
+
+  it('should return false if `data` lengths are different', () => {
+    expect(equalityCheckForQuery(queryResultA1, queryResultA3)).toBe(false)
+  })
+
+  it('should return false if elements in `data` are different', () => {
+    expect(equalityCheckForQuery(queryResultA1, queryResultA3)).toBe(false)
+    expect(equalityCheckForQuery(queryResultA3, queryResultA4)).toBe(false)
+    expect(equalityCheckForQuery(queryResultB1, queryResultB2)).toBe(false)
+  })
+
+  it('should return true for matching data array, with equal references ', () => {
+    expect(equalityCheckForQuery(queryResultA1, queryResultA2)).toBe(true)
+  })
+
+  it('should return false for matching data array, with different references ', () => {
+    const queryResShallowCopyA1 = {
+      ...queryResultA1,
+      storeData: JSON.parse(JSON.stringify(queryResultA1.storeData)) // Deep copy
+    }
+    expect(equalityCheckForQuery(queryResultA1, queryResShallowCopyA1)).toBe(
+      false
+    )
+  })
+
+  it('should return true for matching object data', () => {
+    expect(equalityCheckForQuery(queryResultC1, queryResultC2)).toBe(true)
+  })
+  it('should return false for different object data', () => {
+    expect(equalityCheckForQuery(queryResultC1, queryResultC3)).toBe(false)
+  })
+})
+
+describe('equalityCheckForQuery with relationships', () => {
+  const queryResA = {
+    ...defaultQueryResult,
+    relationshipNames: ['relation1'],
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', [
+      'doc1',
+      'doc2'
+    ]),
+    data: [{ relation1: { _rev: 'rev1' } }]
+  }
+
+  const queryResB = {
+    ...defaultQueryResult,
+    relationshipNames: ['relation1'],
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', [
+      'doc1',
+      'doc2'
+    ]),
+    data: [{ relation1: { _rev: 'rev2' } }]
+  }
+
+  const queryResC = {
+    ...defaultQueryResult,
+    relationshipNames: ['relation1'],
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', [
+      'doc1',
+      'doc2'
+    ]),
+    data: [{ relation1: { _rev: 'rev1' } }, { relation1: { _rev: 'rev2' } }]
+  }
+
+  const queryResD = {
+    ...defaultQueryResult,
+    relationshipNames: ['relation1', 'relation2'],
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', [
+      'doc1',
+      'doc2'
+    ]),
+    data: [{ relation1: { _rev: 'rev1' } }, { relation2: { _rev: 'rev2' } }]
+  }
+
+  const queryResE = {
+    ...defaultQueryResult,
+    relationshipNames: ['relation1'],
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', ['doc1']),
+    data: [{ relation1: { _id: '123' } }]
+  }
+
+  const queryResF = {
+    ...defaultQueryResult,
+    relationshipNames: ['relation1'],
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', ['doc1']),
+    data: [{ relation1: { _id: '123' } }]
+  }
+
+  it('returns true when data and relationship revisions match', () => {
+    expect(equalityCheckForQuery(queryResA, queryResA)).toBe(true)
+    expect(equalityCheckForQuery(queryResD, queryResD)).toBe(true)
+  })
+
+  it('returns false when relationship revisions differ', () => {
+    expect(equalityCheckForQuery(queryResA, queryResB)).toBe(false)
+  })
+
+  it('returns false when relationship revisions are missing', () => {
+    expect(equalityCheckForQuery(queryResE, queryResF)).toBe(false)
+  })
+
+  it('returns false when data lengths differ', () => {
+    expect(equalityCheckForQuery(queryResA, queryResC)).toBe(false)
+  })
+})

package/dist/store.spec.js

@@ -408,7 +408,9 @@ describe('Store', () => {
         hasMore: false,
         count: 0,
         fetchedPagesCount: 0,
-        data: null
+        data: null,
+        storeData: [],
+        relationshipNames: []
       })
     })
 

package/dist/types.js

@@ -276,16 +276,22 @@ var _dsl = require("./queries/dsl");
  * @property {number} fetchedPagesCount
  * @property {string} bookmark
  * @property {object} [execution_stats]
+ * @property {Array<string>} relationshipNames - The relationships names, used to check hydrated documents
  * @property {QueryOptions} [options]
  */
 
 /**
  * @typedef {object} QueryStateData
- * @property {object|Array} data
+ * @property {object|Array} data - Collection of hydrated documents
  */
 
 /**
- * @typedef {QueryStateWithoutData & QueryStateData} QueryState
+ * @typedef {object} QueryStateStoreData
+ * @property {object|Array} storeData - Collection of store's documents
+ */
+
+/**
+ * @typedef {QueryStateWithoutData & QueryStateData & QueryStateStoreData} QueryState
  */
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "59.3.0",
+  "version": "60.0.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -19,7 +19,7 @@
     "@types/jest": "^26.0.20",
     "@types/lodash": "^4.14.170",
     "btoa": "^1.2.1",
-    "cozy-stack-client": "^59.3.0",
+    "cozy-stack-client": "^60.0.0",
     "date-fns": "2.29.3",
     "fast-deep-equal": "^3.1.3",
     "json-stable-stringify": "^1.0.1",
@@ -74,5 +74,5 @@
     "react-native-ios11-devicecheck": "^0.0.3"
   },
   "sideEffects": false,
-  "gitHead": "baea78d5c14a8135d40a5eec689fa9be4aceaec8"
+  "gitHead": "a89eb840497357fb366bc97d92e4a5880fd55099"
 }

package/types/CozyClient.d.ts

@@ -49,6 +49,9 @@ export type ClientOptions = {
     uri?: string;
     stackClient?: object;
     warningForCustomHandlers?: boolean;
+    /**
+     * - If set to true, all documents will be hydrated w.r.t. the provided schema's relationships, even if the relationship does not exist on the doc.
+     */
     autoHydrate?: boolean;
     /**
      * - If set to true, backgroundFetching will be enabled by default on every query. Meaning that, when the fetchStatus has already been loaded, it won't be updated during future fetches. Instead, a `isFetching` attribute will be used to indicate when background fetching is started.
@@ -96,7 +99,7 @@ export type ClientOptions = {
  * @property {string} [uri]
  * @property {object} [stackClient]
  * @property {boolean} [warningForCustomHandlers]
- * @property {boolean} [autoHydrate]
+ * @property {boolean} [autoHydrate] - If set to true, all documents will be hydrated w.r.t. the provided schema's relationships, even if the relationship does not exist on the doc.
  * @property {boolean} [backgroundFetching] - If set to true, backgroundFetching will be enabled by default on every query. Meaning that, when the fetchStatus has already been loaded, it won't be updated during future fetches. Instead, a `isFetching` attribute will be used to indicate when background fetching is started.
  * @property {object} [oauth]
  * @property {Function} [onTokenRefresh]
@@ -108,7 +111,6 @@ export type ClientOptions = {
  * @property  {import("./types").ClientCapabilities} [capabilities] - Capabilities sent by the stack
  * @property  {boolean} [useCustomStore=false] - If set to true, the client will not instantiate a Redux store automatically. Use this if you want to merge cozy-client's store with your own redux store. Note will have to call `setStore` eventually. See [here](https://docs.cozy.io/en/cozy-client/react-integration/#1b-use-your-own-redux-store) for more information.
  * @property  {boolean} [disableStoreForQueries=false] - If set to true, the client will not leverage the redux store to execute queries and store data.
- 
  * @property {import('./performances/types').PerformanceAPI} [performanceApi] - The performance API that can be used to measure performances
  */
 /**
@@ -210,6 +212,9 @@ declare class CozyClient {
         uri?: string;
         stackClient?: object;
         warningForCustomHandlers?: boolean;
+        /**
+         * - If set to true, all documents will be hydrated w.r.t. the provided schema's relationships, even if the relationship does not exist on the doc.
+         */
         autoHydrate?: boolean;
         /**
          * - If set to true, backgroundFetching will be enabled by default on every query. Meaning that, when the fetchStatus has already been loaded, it won't be updated during future fetches. Instead, a `isFetching` attribute will be used to indicate when background fetching is started.
@@ -255,6 +260,7 @@ declare class CozyClient {
      */
     storeAccesors: object;
     useCustomStore: boolean;
+    autoHydrate: boolean;
     disableStoreForQueries: boolean;
     /**
      * Gets overrided by MicroEE.mixin
@@ -607,12 +613,6 @@ declare class CozyClient {
     hydrateRelationships(document: any, schemaRelationships: any): {
         [x: string]: any;
     };
-    /**
-     * Creates (locally) a new document for the given doctype.
-     * This document is hydrated : its relationships are there
-     * and working.
-     */
-    makeNewDocument(doctype: any): any;
     generateRandomId(): string;
     /**
      * Creates an association that is linked to the store.
@@ -662,7 +662,7 @@ declare class CozyClient {
      *
      * @param {string} id - Id of the query (set via Query.props.as)
      * @param {object} options - Options
-     * @param {boolean} [options.hydrated] - Whether documents should be returned already hydrated (default: false)
+     * @param {boolean} [options.hydrated] - Whether documents should be returned already hydrated
      * @param  {object} [options.singleDocData] - If true, the "data" returned will be
      * a single doc instead of an array for single doc queries. Defaults to false for backward
      * compatibility but will be set to true in the future.

package/types/__tests__/fixtures.d.ts

@@ -94,7 +94,7 @@ export namespace TODO_WITH_AUTHOR {
     }
     export { relationships_1 as relationships };
 }
-export namespace FILE_1 {
+export namespace TODO_WITH_NONEXISTING_RELATIONSHIP {
     const _id_6: number;
     export { _id_6 as _id };
     const _rev_6: string;
@@ -103,9 +103,20 @@ export namespace FILE_1 {
     export { _type_6 as _type };
     const label_6: string;
     export { label_6 as label };
-    export const name: string;
+    export namespace relationships_2 {
+        namespace broken {
+            const doctype_2: string;
+            export { doctype_2 as doctype };
+            const data_1: {
+                _type: string;
+                _id: number;
+            }[];
+            export { data_1 as data };
+        }
+    }
+    export { relationships_2 as relationships };
 }
-export namespace FILE_2 {
+export namespace FILE_1 {
     const _id_7: number;
     export { _id_7 as _id };
     const _rev_7: string;
@@ -114,6 +125,17 @@ export namespace FILE_2 {
     export { _type_7 as _type };
     const label_7: string;
     export { label_7 as label };
+    export const name: string;
+}
+export namespace FILE_2 {
+    const _id_8: number;
+    export { _id_8 as _id };
+    const _rev_8: string;
+    export { _rev_8 as _rev };
+    const _type_8: string;
+    export { _type_8 as _type };
+    const label_8: string;
+    export { label_8 as label };
 }
 export const APP_NAME: "cozy-client-test";
 export const APP_VERSION: 2;
@@ -122,38 +144,38 @@ export const SOURCE_ACCOUNT_ID: "123-456-abc";
 export const SOURCE_ACCOUNT_IDENTIFIER: "testSourceAccountIdentifier";
 export namespace SCHEMA {
     export namespace todos {
-        const doctype_2: string;
-        export { doctype_2 as doctype };
+        const doctype_3: string;
+        export { doctype_3 as doctype };
         export { DOCTYPE_VERSION as doctypeVersion };
-        export namespace relationships_2 {
+        export namespace relationships_3 {
             export namespace attachments_1 {
                 export const type: string;
-                const doctype_3: string;
-                export { doctype_3 as doctype };
+                const doctype_4: string;
+                export { doctype_4 as doctype };
             }
             export { attachments_1 as attachments };
             export namespace authors_1 {
                 const type_1: string;
                 export { type_1 as type };
-                const doctype_4: string;
-                export { doctype_4 as doctype };
+                const doctype_5: string;
+                export { doctype_5 as doctype };
             }
             export { authors_1 as authors };
         }
-        export { relationships_2 as relationships };
+        export { relationships_3 as relationships };
     }
     export namespace files_1 {
-        const doctype_5: string;
-        export { doctype_5 as doctype };
-        export namespace relationships_3 {
+        const doctype_6: string;
+        export { doctype_6 as doctype };
+        export namespace relationships_4 {
             namespace icons {
                 const type_2: string;
                 export { type_2 as type };
-                const doctype_6: string;
-                export { doctype_6 as doctype };
+                const doctype_7: string;
+                export { doctype_7 as doctype };
             }
         }
-        export { relationships_3 as relationships };
+        export { relationships_4 as relationships };
     }
     export { files_1 as files };
 }

package/types/store/selector.d.ts

@@ -0,0 +1 @@
+export function equalityCheckForQuery(queryResA: import("../types").QueryState, queryResB: import("../types").QueryState): boolean;

package/types/types.d.ts

@@ -503,12 +503,25 @@ export type QueryStateWithoutData = {
     fetchedPagesCount: number;
     bookmark: string;
     execution_stats?: object;
+    /**
+     * - The relationships names, used to check hydrated documents
+     */
+    relationshipNames: Array<string>;
     options?: QueryOptions;
 };
 export type QueryStateData = {
+    /**
+     * - Collection of hydrated documents
+     */
     data: object | any[];
 };
-export type QueryState = QueryStateWithoutData & QueryStateData;
+export type QueryStateStoreData = {
+    /**
+     * - Collection of store's documents
+     */
+    storeData: object | any[];
+};
+export type QueryState = QueryStateWithoutData & QueryStateData & QueryStateStoreData;
 export type AutoUpdateOptions = any;
 export type QueryOptions = {
     /**
@@ -568,7 +581,7 @@ export type FetchMoreAble = {
 export type FetchAble = {
     fetch: Function;
 };
-export type UseQueryReturnValue = QueryStateWithoutData & QueryStateData & FetchMoreAble & FetchAble;
+export type UseQueryReturnValue = QueryStateWithoutData & QueryStateData & QueryStateStoreData & FetchMoreAble & FetchAble;
 export type UseMutationWithoutMutate = {
     /**
      * - Status of the current mutation