cozy-client 32.3.3 → 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
@@ -1233,6 +1234,7 @@ var CozyClient = /*#__PURE__*/function () {
             queryId,
             existingQuery,
             shouldFetch,
+            backgroundFetching,
             response,
             _args8 = arguments;
 
@@ -1286,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) {
@@ -2565,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.3";
+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/hooks/useQuery.spec.jsx

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "32.3.3",
+  "version": "32.4.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -73,5 +73,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "e8d0916a43759433221c24dc62c48ca1627b5f96"
+  "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;
         /**

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
      */