cozy-client 32.3.1 → 32.4.0

package/dist/CozyClient.js

@@ -140,6 +140,7 @@ var DOC_UPDATE = 'update';
  * @property {object} [stackClient]
  * @property {boolean} [warningForCustomHandlers]
  * @property {boolean} [autoHydrate]
+ * @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]
  * @property {Function} [onError] - Default callback if a query is errored
@@ -189,35 +190,38 @@ var CozyClient = /*#__PURE__*/function () {
     var rawOptions = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     (0, _classCallCheck2.default)(this, CozyClient);
     (0, _defineProperty2.default)(this, "fetchQueryAndGetFromState", /*#__PURE__*/function () {
-      var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(query) {
+      var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(_ref) {
+        var definition, options;
         return _regenerator.default.wrap(function _callee$(_context) {
           while (1) {
             switch (_context.prev = _context.next) {
               case 0:
-                _context.prev = 0;
-                _context.next = 3;
-                return _this.query(query.definition, query.options);
+                definition = _ref.definition, options = _ref.options;
+                _context.prev = 1;
+                _context.next = 4;
+                return _this.query(definition, options);
 
-              case 3:
-                return _context.abrupt("return", _this.getQueryFromState(query.options.as));
+              case 4:
+                return _context.abrupt("return", _this.getQueryFromState(options.as));
 
-              case 6:
-                _context.prev = 6;
-                _context.t0 = _context["catch"](0);
+              case 7:
+                _context.prev = 7;
+                _context.t0 = _context["catch"](1);
                 throw _context.t0;
 
-              case 9:
+              case 10:
               case "end":
                 return _context.stop();
             }
           }
-        }, _callee, null, [[0, 6]]);
+        }, _callee, null, [[1, 7]]);
       }));
 
       return function (_x) {
-        return _ref.apply(this, arguments);
+        return _ref2.apply(this, arguments);
       };
     }());
+
     var link = rawOptions.link,
         links = rawOptions.links,
         _rawOptions$schema = rawOptions.schema,
@@ -225,15 +229,15 @@ var CozyClient = /*#__PURE__*/function () {
         _rawOptions$appMetada = rawOptions.appMetadata,
         appMetadata = _rawOptions$appMetada === void 0 ? {} : _rawOptions$appMetada,
         capabilities = rawOptions.capabilities,
-        options = (0, _objectWithoutProperties2.default)(rawOptions, ["link", "links", "schema", "appMetadata", "capabilities"]);
+        _options = (0, _objectWithoutProperties2.default)(rawOptions, ["link", "links", "schema", "appMetadata", "capabilities"]);
 
     if (link) {
       console.warn('`link` is deprecated, use `links`');
     }
 
     this.appMetadata = appMetadata;
-    options.uri = securiseUri(options.uri);
-    this.options = options;
+    _options.uri = securiseUri(_options.uri);
+    this.options = _options;
     this.queryIdGenerator = new _queries.QueryIDGenerator();
     this.isLogged = false;
     this.instanceOptions = {}; // Bind handlers
@@ -266,7 +270,7 @@ var CozyClient = /*#__PURE__*/function () {
     } catch (err) {// not a critical error, we may be in node or the instance options are not on the default HTML element
     }
 
-    if (options.uri && options.token) {
+    if (_options.uri && _options.token) {
       this.login();
     }
     /**
@@ -276,7 +280,7 @@ var CozyClient = /*#__PURE__*/function () {
 
     this.storeAccesors = null;
 
-    if (options.store !== false) {
+    if (_options.store !== false) {
       this.ensureStore();
     }
     /**
@@ -873,8 +877,11 @@ var CozyClient = /*#__PURE__*/function () {
      * - Can only be called with documents from the same doctype
      * - Does not support automatic creation of references
      *
-     * @param  {CozyClientDocument[]} docs
-     * @param  {Object} mutationOptions
+     * @param  {CozyClientDocument[]} docs - Documents from the same doctype
+     * @param  {Object} mutationOptions - Mutation Options
+     * @param  {string}    [mutationOptions.as] - Mutation id
+     * @param  {Function}    [mutationOptions.update] - Function to update the document
+     * @param  {Function}    [mutationOptions.updateQueries] - Function to update queries
      * @returns {Promise<void>}
      */
 
@@ -948,6 +955,13 @@ var CozyClient = /*#__PURE__*/function () {
 
       return saveAll;
     }()
+    /**
+     * @param  {CozyClientDocument} document - Document that will be saved
+     * @param {object} [options={event: DOC_CREATION}] - Event
+     * @param {string} [options.event] - Mutation type
+     * @returns {CozyClientDocument}
+     */
+
   }, {
     key: "ensureCozyMetadata",
     value: function ensureCozyMetadata(document) {
@@ -1032,7 +1046,7 @@ var CozyClient = /*#__PURE__*/function () {
      * ```
      *
      *
-     * @param  {object} document - Document to create
+     * @param  {CozyClientDocument} document - Document to create
      * @param  {ReferenceMap} [referencesByName] - References to the created document. The
      * relationship class associated to each reference list should support references, otherwise this
      * method will throw.
@@ -1074,10 +1088,10 @@ var CozyClient = /*#__PURE__*/function () {
       return [saveMutation, function (response) {
         var doc = _this3.hydrateDocument(response.data);
 
-        return Object.entries(referencesByName).map(function (_ref2) {
-          var _ref3 = (0, _slicedToArray2.default)(_ref2, 2),
-              relName = _ref3[0],
-              references = _ref3[1];
+        return Object.entries(referencesByName).map(function (_ref3) {
+          var _ref4 = (0, _slicedToArray2.default)(_ref3, 2),
+              relName = _ref4[0],
+              references = _ref4[1];
 
           var relationship = doc[relName];
           return relationship.addReferences(references);
@@ -1214,12 +1228,13 @@ var CozyClient = /*#__PURE__*/function () {
       var _query = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee8(queryDefinition) {
         var _this4 = this;
 
-        var _ref4,
+        var _ref5,
             update,
             options,
             queryId,
             existingQuery,
             shouldFetch,
+            backgroundFetching,
             response,
             _args8 = arguments;
 
@@ -1227,8 +1242,8 @@ var CozyClient = /*#__PURE__*/function () {
           while (1) {
             switch (_context8.prev = _context8.next) {
               case 0:
-                _ref4 = _args8.length > 1 && _args8[1] !== undefined ? _args8[1] : {};
-                update = _ref4.update, options = (0, _objectWithoutProperties2.default)(_ref4, ["update"]);
+                _ref5 = _args8.length > 1 && _args8[1] !== undefined ? _args8[1] : {};
+                update = _ref5.update, options = (0, _objectWithoutProperties2.default)(_ref5, ["update"]);
                 this.ensureStore();
                 queryId = options.as || this.queryIdGenerator.generateId(queryDefinition);
                 existingQuery = this.getQueryFromState(queryId);
@@ -1273,55 +1288,59 @@ var CozyClient = /*#__PURE__*/function () {
               case 14:
                 this.ensureQueryExists(queryId, queryDefinition, options);
                 _context8.prev = 15;
-                this.dispatch((0, _store.loadQuery)(queryId));
-                _context8.next = 19;
+                backgroundFetching = options.backgroundFetching !== undefined ? options.backgroundFetching : this.options.backgroundFetching;
+                this.dispatch((0, _store.loadQuery)(queryId, {
+                  backgroundFetching: backgroundFetching
+                }));
+                _context8.next = 20;
                 return this._promiseCache.exec(function () {
                   return _this4.requestQuery(queryDefinition);
                 }, function () {
                   return (0, _jsonStableStringify.default)(queryDefinition);
                 });
 
-              case 19:
+              case 20:
                 response = _context8.sent;
                 this.dispatch((0, _store.receiveQueryResult)(queryId, response, {
-                  update: update
+                  update: update,
+                  backgroundFetching: backgroundFetching
                 }));
                 return _context8.abrupt("return", response);
 
-              case 24:
-                _context8.prev = 24;
+              case 25:
+                _context8.prev = 25;
                 _context8.t0 = _context8["catch"](15);
                 this.dispatch((0, _store.receiveQueryError)(queryId, _context8.t0)); // specific onError
 
                 if (!options.onError) {
-                  _context8.next = 31;
+                  _context8.next = 32;
                   break;
                 }
 
                 options.onError(_context8.t0); // defaulted onError
 
-                _context8.next = 36;
+                _context8.next = 37;
                 break;
 
-              case 31:
+              case 32:
                 if (!this.options.onError) {
-                  _context8.next = 35;
+                  _context8.next = 36;
                   break;
                 }
 
                 this.options.onError(_context8.t0);
-                _context8.next = 36;
+                _context8.next = 37;
                 break;
 
-              case 35:
+              case 36:
                 throw _context8.t0;
 
-              case 36:
+              case 37:
               case "end":
                 return _context8.stop();
             }
           }
-        }, _callee8, this, [[15, 24]]);
+        }, _callee8, this, [[15, 25]]);
       }));
 
       function query(_x9) {
@@ -1446,7 +1465,7 @@ var CozyClient = /*#__PURE__*/function () {
     key: "mutate",
     value: function () {
       var _mutate = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee10(mutationDefinition) {
-        var _ref5,
+        var _ref6,
             update,
             updateQueries,
             options,
@@ -1458,8 +1477,8 @@ var CozyClient = /*#__PURE__*/function () {
           while (1) {
             switch (_context10.prev = _context10.next) {
               case 0:
-                _ref5 = _args10.length > 1 && _args10[1] !== undefined ? _args10[1] : {};
-                update = _ref5.update, updateQueries = _ref5.updateQueries, options = (0, _objectWithoutProperties2.default)(_ref5, ["update", "updateQueries"]);
+                _ref6 = _args10.length > 1 && _args10[1] !== undefined ? _args10[1] : {};
+                update = _ref6.update, updateQueries = _ref6.updateQueries, options = (0, _objectWithoutProperties2.default)(_ref6, ["update", "updateQueries"]);
                 this.ensureStore();
                 mutationId = options.as || this.queryIdGenerator.generateId(mutationDefinition);
                 this.dispatch((0, _store.initMutation)(mutationId, mutationDefinition));
@@ -1928,6 +1947,8 @@ var CozyClient = /*#__PURE__*/function () {
      * Has a behavior close to <Query /> or useQuery
      *
      * @param {object} query - Query with definition and options
+     * @param {QueryDefinition} query.definition - Query Definition
+     * @param {QueryOptions} query.options - Query Options
      * @returns {Promise<QueryState>} Query state
      */
 
@@ -2050,12 +2071,12 @@ var CozyClient = /*#__PURE__*/function () {
     key: "authorize",
     value: function () {
       var _authorize = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee16() {
-        var _ref6,
-            _ref6$openURLCallback,
+        var _ref7,
+            _ref7$openURLCallback,
             openURLCallback,
-            _ref6$sessionCode,
+            _ref7$sessionCode,
             sessionCode,
-            _ref6$pkceCodes,
+            _ref7$pkceCodes,
             pkceCodes,
             codeVerifier,
             codeChallenge,
@@ -2072,7 +2093,7 @@ var CozyClient = /*#__PURE__*/function () {
           while (1) {
             switch (_context16.prev = _context16.next) {
               case 0:
-                _ref6 = _args16.length > 0 && _args16[0] !== undefined ? _args16[0] : {}, _ref6$openURLCallback = _ref6.openURLCallback, openURLCallback = _ref6$openURLCallback === void 0 ? _mobile.authFunction : _ref6$openURLCallback, _ref6$sessionCode = _ref6.sessionCode, sessionCode = _ref6$sessionCode === void 0 ? undefined : _ref6$sessionCode, _ref6$pkceCodes = _ref6.pkceCodes, pkceCodes = _ref6$pkceCodes === void 0 ? {} : _ref6$pkceCodes;
+                _ref7 = _args16.length > 0 && _args16[0] !== undefined ? _args16[0] : {}, _ref7$openURLCallback = _ref7.openURLCallback, openURLCallback = _ref7$openURLCallback === void 0 ? _mobile.authFunction : _ref7$openURLCallback, _ref7$sessionCode = _ref7.sessionCode, sessionCode = _ref7$sessionCode === void 0 ? undefined : _ref7$sessionCode, _ref7$pkceCodes = _ref7.pkceCodes, pkceCodes = _ref7$pkceCodes === void 0 ? {} : _ref7$pkceCodes;
                 _context16.prev = 1;
                 codeVerifier = pkceCodes.codeVerifier, codeChallenge = pkceCodes.codeChallenge;
                 stackClient = this.getStackClient();
@@ -2169,9 +2190,9 @@ var CozyClient = /*#__PURE__*/function () {
   }, {
     key: "setStore",
     value: function setStore(store) {
-      var _ref7 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
-          _ref7$force = _ref7.force,
-          force = _ref7$force === void 0 ? false : _ref7$force;
+      var _ref8 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
+          _ref8$force = _ref8.force,
+          force = _ref8$force === void 0 ? false : _ref8$force;
 
       if (store === undefined) {
         throw new Error('Store is undefined');
@@ -2365,10 +2386,10 @@ var CozyClient = /*#__PURE__*/function () {
       var _this10 = this;
 
       this.ensureStore();
-      Object.entries(data).forEach(function (_ref8) {
-        var _ref9 = (0, _slicedToArray2.default)(_ref8, 2),
-            doctype = _ref9[0],
-            data = _ref9[1];
+      Object.entries(data).forEach(function (_ref9) {
+        var _ref10 = (0, _slicedToArray2.default)(_ref9, 2),
+            doctype = _ref10[0],
+            data = _ref10[1];
 
         _this10.dispatch((0, _store.receiveQueryResult)(null, {
           data: data
@@ -2550,7 +2571,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 = "32.3.1";
+CozyClient.version = "32.4.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/CozyClient.spec.js

@@ -28,7 +28,8 @@ import {
   receiveMutationResult,
   receiveMutationError,
   getQueryFromState,
-  getRawQueryFromState
+  getRawQueryFromState,
+  loadQuery
 } from './store'
 import { HasManyFiles, Association, HasMany } from './associations'
 import mapValues from 'lodash/mapValues'
@@ -1417,6 +1418,44 @@ describe('CozyClient', () => {
       )
     })
 
+    it('should dispatch a LOAD_QUERY action', async () => {
+      requestHandler.mockResolvedValueOnce(fakeResponse)
+      getQueryFromState.mockReturnValueOnce({
+        fetchStatus: 'loaded'
+      })
+      await client.query(query, { as: 'allTodos' })
+      expect(client.store.dispatch.mock.calls[1][0]).toEqual(
+        loadQuery('allTodos', {})
+      )
+    })
+
+    it('should dispatch a LOAD_QUERY action providing backgroundFetching when set', async () => {
+      requestHandler.mockResolvedValueOnce(fakeResponse)
+      getQueryFromState.mockReturnValueOnce({
+        fetchStatus: 'loaded'
+      })
+      await client.query(query, { as: 'allTodos', backgroundFetching: true })
+      expect(client.store.dispatch.mock.calls[1][0]).toEqual(
+        loadQuery('allTodos', { backgroundFetching: true })
+      )
+    })
+
+    it('should dispatch a RECEIVE_QUERY_RESULT action providing backgroundFetching when set', async () => {
+      requestHandler.mockResolvedValueOnce(fakeResponse)
+      getQueryFromState.mockReturnValueOnce({
+        fetchStatus: 'loaded'
+      })
+      query.skip = 100
+      await client.query(query, { as: 'allTodos', backgroundFetching: true })
+      const dispatchCalls = client.store.dispatch.mock.calls
+      const lastDispatchCall = dispatchCalls[dispatchCalls.length - 1]
+      expect(lastDispatchCall[0]).toEqual(
+        receiveQueryResult('allTodos', fakeResponse, {
+          backgroundFetching: true
+        })
+      )
+    })
+
     it('should dispatch a RECEIVE_QUERY_RESULT action if query has skip', async () => {
       requestHandler.mockResolvedValueOnce(fakeResponse)
       getQueryFromState.mockReturnValueOnce({

package/dist/Query.spec.jsx

@@ -192,6 +192,7 @@ describe('Query', () => {
           fetchStatus: 'pending',
           hasMore: false,
           id: '1',
+          isFetching: null,
           lastError: null,
           lastFetch: null,
           lastUpdate: null,

package/dist/authentication/mobile.js

@@ -27,7 +27,7 @@ var win = typeof window !== 'undefined' ? window : null;
 /**
  * Open a SafariView Controller and resolve with the URL containing the token
  *
- * @param {string} url
+ * @param {string} url - Url containing access_code and state
  * @returns {Promise}
  */
 
@@ -65,7 +65,7 @@ var authenticateWithSafari = function authenticateWithSafari(url) {
 /**
  * Opens an InAppBrowser and resolves with the URL containing the token
  *
- * @param {string} url
+ * @param {string} url - Url containing access_code and state
  * @returns {Promise}
  */
 

package/dist/devtools/Queries.js

@@ -93,7 +93,7 @@ var getClassNameForExecutedTimesQuery = function getClassNameForExecutedTimesQue
   }
 };
 /**
- * @param  {{ queryState: QueryState }} props
+ * @param  {{ queryState: QueryState }} props - Query state containing fetchStatus, lastError
  */
 
 
@@ -106,7 +106,7 @@ var FetchStatus = function FetchStatus(props) {
   }, fetchStatus, fetchStatus === 'failed' ? " - ".concat(lastError) : null);
 };
 /**
- * @param  {{ queryState: QueryState }} props
+ * @param  {{ queryState: QueryState }} props - Query state containing definition
  */
 
 

package/dist/flagship-certification/flagship-certification.js

@@ -17,6 +17,8 @@ var _logger = _interopRequireDefault(require("../logger"));
 
 var _storeAttestation = require("./store-attestation");
 
+var _typedefs = require("./typedefs");
+
 /**
  * Request a challenge from the Stack that can be used to request the app attestation from the app store
  *

package/dist/flagship-certification/store-attestation.android.js

@@ -13,7 +13,9 @@ var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/
 
 var _reactNativeGoogleSafetynet = _interopRequireDefault(require("react-native-google-safetynet"));
 
-//@ts-ignore
+var _typedefs = require("./typedefs");
+
+//@ts-ignore next-line
 
 /**
  * Retrieve the app's attestation from the Google Play store

package/dist/flagship-certification/store-attestation.ios.js

@@ -13,7 +13,9 @@ var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/
 
 var _reactNativeIos11Devicecheck = _interopRequireDefault(require("react-native-ios11-devicecheck"));
 
-//@ts-ignore
+var _typedefs = require("./typedefs");
+
+//@ts-ignore next-line
 
 /**
  * Retrieve the app's attestation from the Apple AppStore

package/dist/flagship-certification/store-attestation.js

@@ -11,6 +11,8 @@ var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"))
 
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 
+var _typedefs = require("./typedefs");
+
 /**
  * Retrieve the app's attestation from the app's store
  * /!\ This is a mock implementation that should never be called

package/dist/flagship-certification/typedefs.js

@@ -1,3 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
 /**
  * @typedef {string} jws - A JSON Web Signature
  */
@@ -17,4 +24,5 @@
  * @typedef {object} CertificationConfig - Configuration to access the stores certification API
  * @property {string} androidSafetyNetApiKey
  */
-"use strict";
+var _default = {};
+exports.default = _default;

package/dist/hooks/useQuery.spec.jsx

@@ -78,6 +78,7 @@ describe('use query', () => {
         'id',
         'definition',
         'fetchStatus',
+        'isFetching',
         'lastFetch',
         'lastUpdate',
         'lastErrorUpdate',

package/dist/manifest.js

@@ -38,9 +38,9 @@ function isPartnershipValid(partnership) {
   return Boolean(partnership && partnership.description);
 }
 /**
- * Normalize app manifest, retrocompatibility for old manifests
+ * Normalize app manifest, retro-compatibility for old manifests
  *
- * @param  {Manifest} manifest
+ * @param  {Manifest} manifest - app manifest to normalize
  * @returns {Manifest}
  */
 

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

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`queries reducer should init correctly 1`] = `
+exports[`queries reducer INIT_QUERY should init correctly 1`] = `
 Object {
   "a": Object {
     "bookmark": null,
@@ -26,6 +26,7 @@ Object {
     "fetchedPagesCount": 0,
     "hasMore": false,
     "id": "a",
+    "isFetching": null,
     "lastError": null,
     "lastErrorUpdate": null,
     "lastFetch": null,
@@ -64,6 +65,7 @@ Object {
     "fetchedPagesCount": 1,
     "hasMore": false,
     "id": "a",
+    "isFetching": null,
     "lastError": null,
     "lastErrorUpdate": null,
     "lastFetch": 1337,
@@ -101,6 +103,7 @@ Object {
     "fetchedPagesCount": 1,
     "hasMore": false,
     "id": "a",
+    "isFetching": null,
     "lastError": null,
     "lastErrorUpdate": null,
     "lastFetch": 1337,
@@ -138,6 +141,7 @@ Object {
     "fetchedPagesCount": 0,
     "hasMore": false,
     "id": "b",
+    "isFetching": null,
     "lastError": null,
     "lastErrorUpdate": null,
     "lastFetch": null,
@@ -175,6 +179,7 @@ Object {
     "fetchedPagesCount": 1,
     "hasMore": false,
     "id": "a",
+    "isFetching": null,
     "lastError": null,
     "lastErrorUpdate": null,
     "lastFetch": 1337,
@@ -209,6 +214,7 @@ Object {
     "fetchedPagesCount": 0,
     "hasMore": false,
     "id": "b",
+    "isFetching": null,
     "lastError": null,
     "lastErrorUpdate": null,
     "lastFetch": null,
@@ -252,6 +258,7 @@ Object {
     "fetchedPagesCount": 1,
     "hasMore": false,
     "id": "a",
+    "isFetching": null,
     "lastError": null,
     "lastErrorUpdate": null,
     "lastFetch": 1337,
@@ -284,6 +291,7 @@ Object {
     "fetchedPagesCount": 0,
     "hasMore": false,
     "id": "b",
+    "isFetching": null,
     "lastError": null,
     "lastErrorUpdate": null,
     "lastFetch": null,
@@ -322,6 +330,7 @@ Object {
     "fetchedPagesCount": 1,
     "hasMore": false,
     "id": "a",
+    "isFetching": null,
     "lastError": null,
     "lastErrorUpdate": null,
     "lastFetch": 1337,
@@ -355,6 +364,7 @@ Object {
     "fetchedPagesCount": 0,
     "hasMore": false,
     "id": "b",
+    "isFetching": null,
     "lastError": null,
     "lastErrorUpdate": null,
     "lastFetch": null,
@@ -392,6 +402,7 @@ Object {
     "fetchedPagesCount": 1,
     "hasMore": false,
     "id": "a",
+    "isFetching": null,
     "lastError": null,
     "lastErrorUpdate": null,
     "lastFetch": 1337,
@@ -424,6 +435,7 @@ Object {
     "fetchedPagesCount": 0,
     "hasMore": false,
     "id": "b",
+    "isFetching": null,
     "lastError": null,
     "lastErrorUpdate": null,
     "lastFetch": null,
@@ -463,6 +475,7 @@ Object {
     "fetchedPagesCount": 0,
     "hasMore": false,
     "id": "a",
+    "isFetching": null,
     "lastError": null,
     "lastErrorUpdate": null,
     "lastFetch": null,
@@ -493,6 +506,7 @@ Object {
     "fetchedPagesCount": 0,
     "hasMore": false,
     "id": "b",
+    "isFetching": null,
     "lastError": null,
     "lastErrorUpdate": null,
     "lastFetch": 1337,
@@ -530,6 +544,7 @@ Object {
     "fetchedPagesCount": 2,
     "hasMore": false,
     "id": "a",
+    "isFetching": null,
     "lastError": null,
     "lastErrorUpdate": null,
     "lastFetch": 1337,
@@ -564,6 +579,7 @@ Object {
     "fetchedPagesCount": 0,
     "hasMore": false,
     "id": "b",
+    "isFetching": null,
     "lastError": null,
     "lastErrorUpdate": null,
     "lastFetch": null,
@@ -605,6 +621,7 @@ Object {
     "fetchedPagesCount": 1,
     "hasMore": false,
     "id": "a",
+    "isFetching": null,
     "lastError": null,
     "lastErrorUpdate": null,
     "lastFetch": 1337,
@@ -637,6 +654,7 @@ Object {
     "fetchedPagesCount": 0,
     "hasMore": false,
     "id": "b",
+    "isFetching": null,
     "lastError": null,
     "lastErrorUpdate": null,
     "lastFetch": null,

package/dist/store/queries.js

@@ -84,6 +84,7 @@ var queryInitialState = {
   id: null,
   definition: null,
   fetchStatus: 'pending',
+  isFetching: null,
   lastFetch: null,
   lastUpdate: null,
   lastErrorUpdate: null,
@@ -187,10 +188,6 @@ var query = function query() {
         id: action.queryId,
         definition: action.queryDefinition,
         options: action.options,
-        // When the query is new, we set "fetchStatus" to "loading"
-        // directly since we know it will be loaded right away.
-        // This way, the loadQuery action will have no effect, and
-        // we save an additional render.
         fetchStatus: state.lastUpdate ? state.fetchStatus : 'pending'
       });
 
@@ -199,6 +196,13 @@ var query = function query() {
         return state;
       }
 
+      if (state.fetchStatus === 'loaded' && action.backgroundFetching) {
+        return _objectSpread(_objectSpread({}, state), {}, {
+          fetchStatus: 'loaded',
+          isFetching: true
+        });
+      }
+
       return _objectSpread(_objectSpread({}, state), {}, {
         fetchStatus: 'loading'
       });
@@ -212,6 +216,7 @@ var query = function query() {
         if (!response.data) {
           return _objectSpread(_objectSpread({}, state), {}, {
             fetchStatus: 'loaded',
+            isFetching: action.backgroundFetching ? false : null,
             lastFetch: Date.now(),
             lastUpdate: Date.now()
           });
@@ -221,6 +226,7 @@ var query = function query() {
 
         var common = _objectSpread({
           fetchStatus: 'loaded',
+          isFetching: action.backgroundFetching ? false : null,
           lastFetch: Date.now(),
           lastUpdate: Date.now()
         }, executionStatsEnabled && {
@@ -254,6 +260,7 @@ var query = function query() {
       return _objectSpread(_objectSpread({}, state), {}, {
         id: action.queryId,
         fetchStatus: 'failed',
+        isFetching: action.backgroundFetching ? false : null,
         lastError: action.error,
         lastErrorUpdate: Date.now()
       });
@@ -566,6 +573,7 @@ var _default = queries;
  * @param  {string} queryId  Name/id of the query
  * @param  {QueryDefinition} queryDefinition - Definition of the created query
  * @param  {QueryOptions} [options] - Options for the created query
+ * @returns {object} Redux action to dispatch
  */
 
 exports.default = _default;
@@ -584,15 +592,32 @@ var initQuery = function initQuery(queryId, queryDefinition) {
     options: options
   };
 };
+/**
+ * Update the fetchStatus when the query is loading
+ *
+ * @param  {string} queryId - id of the query
+ * @param  {QueryOptions} [options] - Options for the created query
+ * @returns {object} Redux action to dispatch
+ */
+
 
 exports.initQuery = initQuery;
 
-var loadQuery = function loadQuery(queryId) {
-  return {
+var loadQuery = function loadQuery(queryId, options) {
+  return _objectSpread({
     type: LOAD_QUERY,
     queryId: queryId
-  };
+  }, options);
 };
+/**
+ * Update the fetchStatus when the query is loading
+ *
+ * @param  {string} queryId - id of the query
+ * @param {object} response - The action response
+ * @param  {QueryOptions} [options] - Options for the created query
+ * @returns {object} Redux action to dispatch
+ */
+
 
 exports.loadQuery = loadQuery;
 
@@ -604,15 +629,25 @@ var receiveQueryResult = function receiveQueryResult(queryId, response) {
     response: response
   }, options);
 };
+/**
+ * Update the fetchStatus when the query is loading
+ *
+ * @param  {string} queryId - id of the query
+ * @param {object} error - The action error
+ * @param  {QueryOptions} [options] - Options for the created query
+ * @returns {object} Redux action to dispatch
+ */
+
 
 exports.receiveQueryResult = receiveQueryResult;
 
 var receiveQueryError = function receiveQueryError(queryId, error) {
-  return {
+  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+  return _objectSpread({
     type: RECEIVE_QUERY_ERROR,
     queryId: queryId,
     error: error
-  };
+  }, options);
 }; // selectors
 
 

package/dist/store/queries.spec.js

@@ -4,14 +4,18 @@ import queries, {
   convert$gtNullSelectors,
   makeSorterFromDefinition,
   mergeSelectorAndPartialIndex,
-  sortAndLimitDocsIds
+  sortAndLimitDocsIds,
+  loadQuery,
+  receiveQueryError
 } from './queries'
 import { Q } from '../queries/dsl'
 import { TODO_1, TODO_2, TODO_3 } from '../__tests__/fixtures'
 
 describe('queries reducer', () => {
   let state
-
+  const response = {
+    data: [TODO_1, TODO_2]
+  }
   const applyAction = action => {
     state = queries(state, action)
   }
@@ -23,35 +27,116 @@ describe('queries reducer', () => {
     Date.now.mockRestore()
   })
 
-  it('should init correctly', () => {
-    const qdef = Q('io.cozy.todos')
-    applyAction(initQuery('a', qdef))
-    expect(state).toMatchSnapshot()
+  describe('INIT_QUERY', () => {
+    it('should init correctly', () => {
+      const qdef = Q('io.cozy.todos')
+      applyAction(initQuery('a', qdef))
+      expect(state).toMatchSnapshot()
+    })
+
+    test('init should have no effect after receiveQueryResult', () => {
+      const qdef = Q('io.cozy.todos')
+      applyAction(initQuery('a', qdef))
+      applyAction(receiveQueryResult('a', response))
+      let state1 = state
+      applyAction(initQuery('a', qdef))
+      expect(state1).toBe(state)
+    })
+
+    test('init should not set status to loading after receiveQueryResult', () => {
+      const qdef = Q('io.cozy.todos')
+      applyAction(initQuery('a', qdef))
+      applyAction(receiveQueryResult('a', response))
+      applyAction(initQuery('a', qdef))
+      expect(state.a.fetchStatus).toBe('loaded')
+    })
   })
 
-  test('init should have no effect after receiveQueryResult', () => {
-    const qdef = Q('io.cozy.todos')
-    applyAction(initQuery('a', qdef))
-    applyAction(
-      receiveQueryResult('a', {
-        data: [TODO_1, TODO_2]
-      })
-    )
-    let state1 = state
-    applyAction(initQuery('a', qdef))
-    expect(state1).toBe(state)
+  describe('LOAD_QUERY', () => {
+    it('should set isFetching to true and not changing fetchStatus when query has been loaded and background fetching activated', () => {
+      // Given
+      const queryDefinition = Q('io.cozy.todos')
+      applyAction(initQuery('a', queryDefinition))
+      applyAction(receiveQueryResult('a', response))
+      expect(state.a.fetchStatus).toBe('loaded')
+
+      // When
+      applyAction(loadQuery('a', { backgroundFetching: true }))
+
+      // Then
+      expect(state.a.fetchStatus).toBe('loaded')
+      expect(state.a.isFetching).toBe(true)
+    })
+
+    it('should not set isFetching and keep changing fetchStatus when query has been loaded and background fetching deactivated', () => {
+      // Given
+      const queryDefinition = Q('io.cozy.todos')
+      applyAction(initQuery('a', queryDefinition))
+      applyAction(receiveQueryResult('a', response))
+      expect(state.a.fetchStatus).toBe('loaded')
+
+      // When
+      applyAction(loadQuery('a'))
+
+      // Then
+      expect(state.a.fetchStatus).toBe('loading')
+      expect(state.a.isFetching).toBe(null)
+    })
   })
 
-  test('init should not set status to loading after receiveQueryResult', () => {
-    const qdef = Q('io.cozy.todos')
-    applyAction(initQuery('a', qdef))
-    applyAction(
-      receiveQueryResult('a', {
-        data: [TODO_1, TODO_2]
-      })
-    )
-    applyAction(initQuery('a', qdef))
-    expect(state.a.fetchStatus).toBe('loaded')
+  describe('RECEIVE_QUERY_RESULT', () => {
+    it('should set isFetching to false when query has been re-fetched correctly and background fetching activated', () => {
+      // Given
+      const queryDefinition = Q('io.cozy.todos')
+      applyAction(initQuery('a', queryDefinition))
+
+      // When
+      applyAction(
+        receiveQueryResult('a', response, { backgroundFetching: true })
+      )
+
+      // Then
+      expect(state.a.isFetching).toBe(false)
+    })
+
+    it('should set isFetching to false when query has been re-fetched correctly and background fetching deactivated', () => {
+      // Given
+      const queryDefinition = Q('io.cozy.todos')
+      applyAction(initQuery('a', queryDefinition))
+
+      // When
+      applyAction(receiveQueryResult('a', response))
+
+      // Then
+      expect(state.a.isFetching).toBe(null)
+    })
+  })
+
+  describe('RECEIVE_QUERY_ERROR', () => {
+    it('should set isFetching to false when query is in error and background fetching activated', () => {
+      // Given
+      const queryDefinition = Q('io.cozy.todos')
+      applyAction(initQuery('a', queryDefinition))
+      const error = {}
+
+      // When
+      applyAction(receiveQueryError('a', error, { backgroundFetching: true }))
+
+      // Then
+      expect(state.a.isFetching).toBe(false)
+    })
+    it('should not set isFetching when query is in error and background fetching deactivated', () => {
+      // Given
+      const queryDefinition = Q('io.cozy.todos')
+      applyAction(initQuery('a', queryDefinition))
+      const error = {}
+
+      // When
+      applyAction(receiveQueryError('a', error))
+
+      // Then
+      expect(state.a.isFetching).toBe(null)
+    })
   })
 
   describe('updates', () => {

package/dist/store.spec.js

@@ -397,6 +397,7 @@ describe('Store', () => {
         definition: null,
         id: 'allTodos',
         fetchStatus: 'pending',
+        isFetching: null,
         lastFetch: null,
         lastUpdate: null,
         lastError: null,

package/dist/types.js

@@ -61,6 +61,7 @@ var _dsl = require("./queries/dsl");
  * @property {string} id
  * @property {QueryDefinition} definition
  * @property {QueryFetchStatus} fetchStatus
+ * @property {boolean} isFetching
  * @property {number} lastFetch
  * @property {number} lastUpdate
  * @property {number} lastErrorUpdate
@@ -89,6 +90,7 @@ var _dsl = require("./queries/dsl");
  * @property {string} [update] - Does not seem to be used
  * @property {Function} [onError] - Callback when the query is errored
  * @property {boolean} [enabled=true] - If set to false, the query won't be executed
+ * @property {boolean} [backgroundFetching] - If set to true, 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} [hydrated=true] - Whether documents should be returned already hydrated
  * @property {object} [singleDocData] - If true, the "data" returned will be
  * a single doc instead of an array for single doc queries. Defaults to false for backward
@@ -158,6 +160,7 @@ var _dsl = require("./queries/dsl");
  * @property {boolean} [_deleted] - When the document has been deleted
  * @property {ReferencedByRelationship} [relationships] - Relationships of the document
  * @property {Reference[]} [referenced_by] - referenced by of another document
+ * @property {object} [cozyMetadata] - Cozy Metadata
  */
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "32.3.1",
+  "version": "32.4.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -18,7 +18,7 @@
     "@types/jest": "^26.0.20",
     "@types/lodash": "^4.14.170",
     "btoa": "^1.2.1",
-    "cozy-stack-client": "^32.2.5",
+    "cozy-stack-client": "^32.3.3",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.13",
     "microee": "^0.0.6",
@@ -73,5 +73,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "c277d63f38e9f9d529ae27b6b3d0f62a783d201c"
+  "gitHead": "4076034cefef149c77dd0393650e4aeea59ebffd"
 }

package/types/CozyClient.d.ts

@@ -8,6 +8,10 @@ export type ClientOptions = {
     stackClient?: object;
     warningForCustomHandlers?: boolean;
     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.
+     */
+    backgroundFetching?: boolean;
     oauth?: object;
     onTokenRefresh?: Function;
     /**
@@ -41,6 +45,7 @@ export type ClientOptions = {
  * @property {object} [stackClient]
  * @property {boolean} [warningForCustomHandlers]
  * @property {boolean} [autoHydrate]
+ * @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]
  * @property {Function} [onError] - Default callback if a query is errored
@@ -148,6 +153,10 @@ declare class CozyClient {
         stackClient?: object;
         warningForCustomHandlers?: boolean;
         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.
+         */
+        backgroundFetching?: boolean;
         oauth?: object;
         onTokenRefresh?: Function;
         /**
@@ -331,14 +340,27 @@ declare class CozyClient {
      * - Can only be called with documents from the same doctype
      * - Does not support automatic creation of references
      *
-     * @param  {CozyClientDocument[]} docs
-     * @param  {Object} mutationOptions
+     * @param  {CozyClientDocument[]} docs - Documents from the same doctype
+     * @param  {Object} mutationOptions - Mutation Options
+     * @param  {string}    [mutationOptions.as] - Mutation id
+     * @param  {Function}    [mutationOptions.update] - Function to update the document
+     * @param  {Function}    [mutationOptions.updateQueries] - Function to update queries
      * @returns {Promise<void>}
      */
-    saveAll(docs: CozyClientDocument[], mutationOptions?: any): Promise<void>;
-    ensureCozyMetadata(document: any, options?: {
-        event: string;
-    }): any;
+    saveAll(docs: CozyClientDocument[], mutationOptions?: {
+        as?: string;
+        update?: Function;
+        updateQueries?: Function;
+    }): Promise<void>;
+    /**
+     * @param  {CozyClientDocument} document - Document that will be saved
+     * @param {object} [options={event: DOC_CREATION}] - Event
+     * @param {string} [options.event] - Mutation type
+     * @returns {CozyClientDocument}
+     */
+    ensureCozyMetadata(document: CozyClientDocument, options?: {
+        event?: string;
+    }): CozyClientDocument;
     /**
      * Dehydrates and adds metadata before saving a document
      *
@@ -360,14 +382,14 @@ declare class CozyClient {
      * ```
      *
      *
-     * @param  {object} document - Document to create
+     * @param  {CozyClientDocument} document - Document to create
      * @param  {ReferenceMap} [referencesByName] - References to the created document. The
      * relationship class associated to each reference list should support references, otherwise this
      * method will throw.
      *
      * @returns {Mutation[]|Mutation}  One or more mutation to execute
      */
-    getDocumentSavePlan(document: object, referencesByName?: ReferenceMap): Mutation[] | Mutation;
+    getDocumentSavePlan(document: CozyClientDocument, referencesByName?: ReferenceMap): Mutation[] | Mutation;
     triggerHook(name: any, document: any): void;
     /**
      * Destroys a document. {before,after}:destroy hooks will be fired.
@@ -542,9 +564,14 @@ declare class CozyClient {
      * Has a behavior close to <Query /> or useQuery
      *
      * @param {object} query - Query with definition and options
+     * @param {QueryDefinition} query.definition - Query Definition
+     * @param {QueryOptions} query.options - Query Options
      * @returns {Promise<QueryState>} Query state
      */
-    fetchQueryAndGetFromState: (query: object) => Promise<QueryState>;
+    fetchQueryAndGetFromState: ({ definition, options }: {
+        definition: QueryDefinition;
+        options: QueryOptions;
+    }) => Promise<QueryState>;
     /**
      * Performs a complete OAuth flow using a Cordova webview
      * or React Native WebView for auth.

package/types/flagship-certification/flagship-certification.d.ts

@@ -1,2 +1,3 @@
 export function certifyFlagship(certificationConfig: CertificationConfig, client: CozyClient): Promise<void>;
+import { CertificationConfig } from "./typedefs";
 import CozyClient from "../CozyClient";

package/types/flagship-certification/store-attestation.android.d.ts

@@ -1 +1,3 @@
 export function getAppAttestationFromStore(nonce: string, certificationConfig: CertificationConfig): Promise<AttestationResult>;
+import { CertificationConfig } from "./typedefs";
+import { AttestationResult } from "./typedefs";

package/types/flagship-certification/store-attestation.d.ts

@@ -7,3 +7,5 @@
  * @returns {Promise<AttestationResult>} the app's attestation
  */
 export function getAppAttestationFromStore(nonce: string, certificationConfig: CertificationConfig): Promise<AttestationResult>;
+import { CertificationConfig } from "./typedefs";
+import { AttestationResult } from "./typedefs";

package/types/flagship-certification/store-attestation.ios.d.ts

@@ -1 +1,3 @@
 export function getAppAttestationFromStore(nonce: string, certificationConfig: CertificationConfig): Promise<AttestationResult>;
+import { CertificationConfig } from "./typedefs";
+import { AttestationResult } from "./typedefs";

package/types/flagship-certification/typedefs.d.ts

@@ -1,15 +1,17 @@
+declare var _default: {};
+export default _default;
 /**
  * - A JSON Web Signature
  */
-type jws = string;
+export type jws = string;
 /**
  * - A JSON Web Signature
  */
-type base64string = string;
+export type base64string = string;
 /**
  * - An app attestation from the app store
  */
-type AttestationResult = {
+export type AttestationResult = {
     platform: string;
     attestation: jws | base64string;
     keyId?: string;
@@ -17,6 +19,6 @@ type AttestationResult = {
 /**
  * - Configuration to access the stores certification API
  */
-type CertificationConfig = {
+export type CertificationConfig = {
     androidSafetyNetApiKey: string;
 };

package/types/manifest.d.ts

@@ -3,9 +3,9 @@ export function sanitizeCategories(categories: any): any;
 export function areTermsValid(terms: any): boolean;
 export function isPartnershipValid(partnership: any): boolean;
 /**
- * Normalize app manifest, retrocompatibility for old manifests
+ * Normalize app manifest, retro-compatibility for old manifests
  *
- * @param  {Manifest} manifest
+ * @param  {Manifest} manifest - app manifest to normalize
  * @returns {Manifest}
  */
 export function sanitize(manifest: Manifest): Manifest;

package/types/store/queries.d.ts

@@ -8,26 +8,10 @@ export function convert$gtNullSelectors(selector: any): object;
 export function mergeSelectorAndPartialIndex(queryDefinition: object): object;
 export function makeSorterFromDefinition(definition: QueryDefinition): (arg0: Array<CozyClientDocument>) => Array<CozyClientDocument>;
 export default queries;
-export function initQuery(queryId: string, queryDefinition: QueryDefinition, options?: QueryOptions): {
-    type: string;
-    queryId: string;
-    queryDefinition: QueryDefinition;
-    options: QueryOptions;
-};
-export function loadQuery(queryId: any): {
-    type: string;
-    queryId: any;
-};
-export function receiveQueryResult(queryId: any, response: any, options?: {}): {
-    type: string;
-    queryId: any;
-    response: any;
-};
-export function receiveQueryError(queryId: any, error: any): {
-    type: string;
-    queryId: any;
-    error: any;
-};
+export function initQuery(queryId: string, queryDefinition: QueryDefinition, options?: QueryOptions): object;
+export function loadQuery(queryId: string, options?: QueryOptions): object;
+export function receiveQueryResult(queryId: string, response: object, options?: QueryOptions): object;
+export function receiveQueryError(queryId: string, error: object, options?: QueryOptions): object;
 export function getQueryFromSlice(state: any, queryId: any, documents: any): any;
 export class QueryIDGenerator {
     idCounter: number;

package/types/types.d.ts

@@ -35,6 +35,7 @@ export type QueryState = {
     id: string;
     definition: QueryDefinition;
     fetchStatus: QueryFetchStatus;
+    isFetching: boolean;
     lastFetch: number;
     lastUpdate: number;
     lastErrorUpdate: number;
@@ -73,6 +74,10 @@ export type QueryOptions = {
      * - If set to false, the query won't be executed
      */
     enabled?: boolean;
+    /**
+     * - If set to true, 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.
+     */
+    backgroundFetching?: boolean;
     /**
      * - Whether documents should be returned already hydrated
      */
@@ -164,6 +169,10 @@ export type CozyClientDocument = {
      * - referenced by of another document
      */
     referenced_by?: Reference[];
+    /**
+     * - Cozy Metadata
+     */
+    cozyMetadata?: object;
 };
 /**
  * - An io.cozy.files document