cozy-client 27.22.3 → 27.25.0

package/dist/CozyClient.js

@@ -2537,7 +2537,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 = "27.22.3";
+CozyClient.version = "27.25.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/authentication/mobile.native.js

@@ -17,15 +17,24 @@ var _reactNative = require("react-native");
 
 //@ts-ignore
 //@ts-ignore
-
+var USER_CANCELED = 'USER_CANCELED';
 /**
  * Opens a ReactNative InAppBrowser
  * and resolves with the URL containing
  * the token
  *
+ * When the user close the InAppBrowser, the promise
+ * rejects with USER_CANCELED message
+ *
+ * When the redirection URL contains `error=access_denied`
+ * the promise rejects with USER_CANCELED message. This means
+ * that the user closed the authorization popup
+ *
  * @param {string} url
  * @returns {Promise}
+ * @throws Will throw an "USER_CANCELED" message when the user cancel the authorization process
  */
+
 var authenticateWithReactNativeInAppBrowser = /*#__PURE__*/function () {
   var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(url) {
     return _regenerator.default.wrap(function _callee$(_context) {
@@ -43,11 +52,12 @@ var authenticateWithReactNativeInAppBrowser = /*#__PURE__*/function () {
                 enableBarCollapsing: false,
                 // Android Properties
                 showTitle: true,
-                toolbarColor: '#6200EE',
+                toolbarColor: '#8e9094',
                 secondaryToolbarColor: 'black',
                 enableUrlBarHiding: true,
                 enableDefaultShare: true,
                 forceCloseOnRedirection: false,
+                showInRecents: true,
                 // Specify full animation resource identifier(package:anim/name)
                 // or only resource name(in case of animation bundled with app).
                 animations: {
@@ -56,6 +66,10 @@ var authenticateWithReactNativeInAppBrowser = /*#__PURE__*/function () {
                   endEnter: 'slide_in_left',
                   endExit: 'slide_out_right'
                 }
+              }).then(function (result) {
+                if (result.type === 'cancel') {
+                  reject(USER_CANCELED);
+                }
               });
 
               var removeListener = function removeListener() {
@@ -67,6 +81,7 @@ var authenticateWithReactNativeInAppBrowser = /*#__PURE__*/function () {
                 var sanitizedUrl = url;
                 var accessCode = /\?access_code=(.+)$/.test(url);
                 var state = /\?state=(.+)$/.test(url);
+                var closeSignal = /\?error=access_denied$/.test(url);
 
                 if (accessCode || state) {
                   if (_reactNative.Platform.OS === 'ios') {
@@ -87,6 +102,8 @@ var authenticateWithReactNativeInAppBrowser = /*#__PURE__*/function () {
                   removeListener();
 
                   _reactNativeInappbrowserReborn.InAppBrowser.close();
+                } else if (closeSignal) {
+                  reject(USER_CANCELED);
                 }
               };
 

package/dist/helpers.spec.js

@@ -155,6 +155,10 @@ describe('rootCozyUrl', () => {
     enableFetchMocks()
   })
 
+  beforeEach(() => {
+    fetch.resetMocks()
+  })
+
   afterAll(() => {
     disableFetchMocks()
   })
@@ -354,7 +358,7 @@ describe('rootCozyUrl', () => {
 
   it('expects an http or https protocol', async () => {
     fetch.mockOnceIf(
-      'ftp://camillenimbus.com',
+      'ftp://camillenimbus.com/.well-known/change-password',
       {},
       {
         status: 200
@@ -368,7 +372,7 @@ describe('rootCozyUrl', () => {
 
   it('rejects if URL points to a valid cozy-stack but no valid Cozy instance', async () => {
     fetch.mockOnceIf(
-      'https://missing.mycozy.cloud',
+      'https://missing.mycozy.cloud/.well-known/change-password',
       {},
       {
         status: 404

package/dist/hooks/helpers/useIsMounted.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = require("react");
+
+// @ts-nocheck
+var useIsMounted = function useIsMounted() {
+  var mounted = (0, _react.useRef)();
+  (0, _react.useEffect)(function () {
+    mounted.current = true;
+    return function () {
+      mounted.current = false;
+    };
+  }, []);
+  return mounted;
+};
+
+var _default = useIsMounted;
+exports.default = _default;

package/dist/hooks/helpers/useSafeState.js

@@ -0,0 +1,34 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+
+var _react = require("react");
+
+var _useIsMounted = _interopRequireDefault(require("./useIsMounted"));
+
+var useSafeState = function useSafeState(initialState) {
+  var mounted = (0, _useIsMounted.default)();
+
+  var _useState = (0, _react.useState)(initialState),
+      _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+      state = _useState2[0],
+      setState = _useState2[1];
+
+  var setSafeState = (0, _react.useCallback)(function (newState) {
+    if (mounted.current) {
+      setState(newState);
+    }
+  }, [] // eslint-disable-line react-hooks/exhaustive-deps
+  );
+  return [state, setSafeState];
+};
+
+var _default = useSafeState;
+exports.default = _default;

package/dist/hooks/index.js

@@ -41,6 +41,12 @@ Object.defineProperty(exports, "useAppsInMaintenance", {
     return _useAppsInMaintenance.default;
   }
 });
+Object.defineProperty(exports, "useQueryAll", {
+  enumerable: true,
+  get: function get() {
+    return _useQueryAll.default;
+  }
+});
 
 var _useAppLinkWithStoreFallback = _interopRequireDefault(require("./useAppLinkWithStoreFallback"));
 
@@ -52,4 +58,6 @@ var _useClient = _interopRequireDefault(require("./useClient"));
 
 var _useQuery = _interopRequireDefault(require("./useQuery"));
 
-var _useAppsInMaintenance = _interopRequireDefault(require("./useAppsInMaintenance"));
+var _useAppsInMaintenance = _interopRequireDefault(require("./useAppsInMaintenance"));
+
+var _useQueryAll = _interopRequireDefault(require("./useQueryAll"));

package/dist/hooks/useQuery.js

@@ -43,17 +43,8 @@ var generateFetchMoreQueryDefinition = function generateFetchMoreQueryDefinition
 /**
  * Fetches a queryDefinition and returns the queryState
  *
- * @param  {QueryDefinition} queryDefinition - Definition created with Q()
- *
- * @typedef {object} UseQueryOptions
- * @property  {object} as - Name for the query [required]
- * @property  {boolean} enabled - If set to false, the query won't be executed
- * @property  {object} fetchPolicy - Fetch policy
- * @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
- * compatibility but will be set to true in the future.
- * @property {Function} onError - Callback if the query is errored
- *
+ * @param {QueryDefinition} queryDefinition - Definition created with Q()
+ * @param {QueryOptions} options - Options created with Q()
  * @returns {UseQueryReturnValue}
  */
 

package/dist/hooks/useQueryAll.js

@@ -0,0 +1,78 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+
+var _react = require("react");
+
+var _types = require("../types");
+
+var _dsl = require("../queries/dsl");
+
+var _useQuery = _interopRequireDefault(require("./useQuery"));
+
+var _useSafeState3 = _interopRequireDefault(require("./helpers/useSafeState"));
+
+/**
+ * Fetches a queryDefinition and run fetchMore on the query until the query is fully loaded
+ *
+ * @param {QueryDefinition} queryDefinition - Definition created with Q()
+ * @param {QueryOptions} options - Options created with Q()
+ * @returns {UseQueryReturnValue}
+ */
+var useQueryAll = function useQueryAll(queryDefinition, options) {
+  var _useSafeState = (0, _useSafeState3.default)(false),
+      _useSafeState2 = (0, _slicedToArray2.default)(_useSafeState, 2),
+      fetching = _useSafeState2[0],
+      setFetching = _useSafeState2[1];
+
+  var res = (0, _useQuery.default)(queryDefinition, options);
+  (0, _react.useEffect)(function () {
+    var checkToFetchMore = /*#__PURE__*/function () {
+      var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
+        return _regenerator.default.wrap(function _callee$(_context) {
+          while (1) {
+            switch (_context.prev = _context.next) {
+              case 0:
+                if (!(res.fetchStatus === 'loaded' && res.hasMore && !fetching)) {
+                  _context.next = 5;
+                  break;
+                }
+
+                setFetching(true);
+                _context.next = 4;
+                return res.fetchMore();
+
+              case 4:
+                setFetching(false);
+
+              case 5:
+              case "end":
+                return _context.stop();
+            }
+          }
+        }, _callee);
+      }));
+
+      return function checkToFetchMore() {
+        return _ref.apply(this, arguments);
+      };
+    }();
+
+    checkToFetchMore(); // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [res.hasMore, res.fetchStatus, fetching]);
+  return res;
+};
+
+var _default = useQueryAll;
+exports.default = _default;

package/dist/hooks/useQueryAll.spec.jsx

@@ -0,0 +1,81 @@
+import React from 'react'
+import { renderHook } from '@testing-library/react-hooks'
+
+import { Q } from '../queries/dsl'
+import { createMockClient } from '../mock'
+import CozyProvider from '../Provider'
+
+import useQueryAll from './useQueryAll'
+
+const sleep = delay => new Promise(resolve => setTimeout(resolve, delay))
+
+describe('useQueryAll', () => {
+  const setup = ({ todosResult }) => {
+    const client = createMockClient({
+      queries: {
+        todos: todosResult
+      }
+    })
+    client.query.mockImplementation(async () => {
+      // give a little time for hook to be re-rendered several times
+      await sleep(10)
+      return {
+        data: [{ _id: '2', done: false }],
+        next: false
+      }
+    })
+    const wrapper = ({ children }) => (
+      <CozyProvider client={client}>{children}</CozyProvider>
+    )
+    const query = Q('io.cozy.todos')
+    const options = {
+      as: 'todos'
+    }
+    const hook = renderHook(() => useQueryAll(query, options), {
+      wrapper
+    })
+    return { client, wrapper, hook }
+  }
+
+  it('should run only 1 fetch more even if the hook is rendered-multiple times', () => {
+    const {
+      client,
+      hook: { result, rerender }
+    } = setup({
+      todosResult: {
+        data: [{ _id: '1', done: true }],
+        next: true,
+        doctype: 'io.cozy.todos'
+      }
+    })
+    expect(result.error).toBeFalsy()
+    rerender()
+    rerender()
+    rerender()
+    rerender()
+
+    // one for the initial query and one for the fetchMore
+    expect(client.query).toHaveBeenCalledTimes(2)
+  })
+
+  it('should not run fetch if there are no more results', () => {
+    const {
+      client,
+      hook: { result, rerender }
+    } = setup({
+      todosResult: {
+        data: [{ _id: '1', done: true }],
+        next: false,
+        doctype: 'io.cozy.todos'
+      }
+    })
+    expect(result.error).toBeFalsy()
+    rerender()
+    rerender()
+    rerender()
+    rerender()
+
+    // one for the initial query and one for the fetchMore
+    expect(client.query).toHaveBeenCalledTimes(1)
+  })
+})

package/dist/models/dacc.js

@@ -0,0 +1,109 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.sendMeasureToDACC = exports.checkMeasureParams = void 0;
+
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+
+var _cozyLogger = _interopRequireDefault(require("cozy-logger"));
+
+var _types = require("../types");
+
+/**
+ * Throw an errror if a DACC parameter is incorrect.
+ *
+ * @param { DACCMeasure} measure - The DACC measure
+ */
+var checkMeasureParams = function checkMeasureParams(measure) {
+  var createdBy = measure.createdBy,
+      measureName = measure.measureName,
+      startDate = measure.startDate,
+      value = measure.value,
+      group1 = measure.group1,
+      group2 = measure.group2,
+      group3 = measure.group3;
+
+  if (!createdBy || typeof createdBy !== 'string') {
+    throw new Error('Missing or wrong type parameter: createdBy');
+  }
+
+  if (!measureName || typeof measureName !== 'string') {
+    throw new Error('Missing or wrong type parameter: measureName');
+  }
+
+  if (!startDate) {
+    throw new Error('Missing parameter: startDate');
+  }
+
+  var parsedDate = new Date(Date.parse(startDate));
+
+  if (!parsedDate.toISOString().startsWith(startDate)) {
+    throw new Error('Date should be in YYYY-MM-DD format');
+  }
+
+  if (!value || typeof value !== 'number') {
+    throw new Error('Missing or wrong type parameter: value');
+  }
+
+  if (group1 && (typeof group1 !== 'object' || Object.keys(group1).length === 0) || group2 && (typeof group2 !== 'object' || Object.keys(group2).length === 0) || group3 && (typeof group3 !== 'object' || Object.keys(group3).length === 0)) {
+    throw new Error('Groups should be key-value objects');
+  }
+
+  if (group3 && (!group2 || !group1) || group2 && !group1) {
+    throw new Error('Group order must be respected');
+  }
+};
+/**
+ * Send measures to a DACC through a remote doctype
+ *
+ * @param {object} client - The CozyClient instance
+ * @param {string} remoteDoctype - The remote doctype to use
+ * @param {DACCMeasure} measure - The DACC measure
+ */
+
+
+exports.checkMeasureParams = checkMeasureParams;
+
+var sendMeasureToDACC = /*#__PURE__*/function () {
+  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(client, remoteDoctype, measure) {
+    return _regenerator.default.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            _context.prev = 0;
+            checkMeasureParams(measure);
+            _context.next = 4;
+            return client.getStackClient().fetchJSON('POST', "/remote/".concat(remoteDoctype), {
+              data: JSON.stringify(measure)
+            });
+
+          case 4:
+            _context.next = 10;
+            break;
+
+          case 6:
+            _context.prev = 6;
+            _context.t0 = _context["catch"](0);
+            (0, _cozyLogger.default)('error', "Error while sending measure to remote doctype: ".concat(_context.t0.message));
+            throw _context.t0;
+
+          case 10:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee, null, [[0, 6]]);
+  }));
+
+  return function sendMeasureToDACC(_x, _x2, _x3) {
+    return _ref.apply(this, arguments);
+  };
+}();
+
+exports.sendMeasureToDACC = sendMeasureToDACC;

package/dist/models/dacc.spec.js

@@ -0,0 +1,99 @@
+import { checkMeasureParams } from './dacc'
+
+describe('dacc', () => {
+  const measure = {
+    value: 42,
+    measureName: 'theanswer',
+    startDate: '2022-01-01',
+    createdBy: 'DeepThought'
+  }
+
+  it('should not throw when all params are corrects', () => {
+    expect(() => checkMeasureParams(measure)).not.toThrow()
+  })
+
+  it('should not throw when all params are corrects with groups', () => {
+    const measureWithGroups = {
+      ...measure,
+      group1: { a: 1 },
+      group2: { b: 1 },
+      group3: { c: 1 }
+    }
+    expect(() => checkMeasureParams(measureWithGroups)).not.toThrow()
+  })
+
+  it('should throw an error when createdBy is missing or malformed', () => {
+    expect(() => checkMeasureParams({ ...measure, createdBy: null })).toThrow()
+    expect(() => checkMeasureParams({ ...measure, createdBy: 123 })).toThrow()
+  })
+
+  it('should throw an error when value is missing or malformed', () => {
+    expect(() => checkMeasureParams({ ...measure, value: null })).toThrow()
+    expect(() =>
+      checkMeasureParams({ ...measure, value: 'notacorrectvalue' })
+    ).toThrow()
+  })
+
+  it('should throw an error when measureName is missing or malformed', () => {
+    expect(() =>
+      checkMeasureParams({ ...measure, measureName: null })
+    ).toThrow()
+    expect(() => checkMeasureParams({ ...measure, measureName: 10 })).toThrow()
+  })
+
+  it('should throw an error when startDate is missing or malformed', () => {
+    expect(() => checkMeasureParams({ ...measure, startDate: null })).toThrow()
+    expect(() => checkMeasureParams({ ...measure, startDate: 123 })).toThrow()
+    expect(() =>
+      checkMeasureParams({ ...measure, startDate: '01 January 2012' })
+    ).toThrow()
+    expect(() =>
+      checkMeasureParams({ ...measure, startDate: '2022:01:01' })
+    ).toThrow()
+  })
+
+  it('should throw an error when groups are not objects', () => {
+    expect(() => checkMeasureParams({ ...measure, group1: '123' })).toThrow()
+    expect(() =>
+      checkMeasureParams({ ...measure, group1: { a: 1 }, group2: '456' })
+    ).toThrow()
+    expect(() =>
+      checkMeasureParams({
+        ...measure,
+        group1: { a: 1 },
+        group2: { b: 1 },
+        group3: '789'
+      })
+    ).toThrow()
+  })
+
+  it('should throw an error when groups are empty objects', () => {
+    expect(() => checkMeasureParams({ ...measure, group1: {} })).toThrow()
+    expect(() =>
+      checkMeasureParams({ ...measure, group1: { a: 1 }, group2: {} })
+    ).toThrow()
+    expect(() =>
+      checkMeasureParams({
+        ...measure,
+        group1: { a: 1 },
+        group2: { b: 1 },
+        group3: {}
+      })
+    ).toThrow()
+  })
+
+  it('should throw an error when groups order is not respected', () => {
+    expect(() => checkMeasureParams({ ...measure, group2: { b: 1 } })).toThrow()
+    expect(() => checkMeasureParams({ ...measure, group3: { c: 1 } })).toThrow()
+    expect(() =>
+      checkMeasureParams({
+        ...measure,
+        group1: { a: 1 },
+        group3: { c: 1 }
+      })
+    ).toThrow()
+    expect(() =>
+      checkMeasureParams({ ...measure, group2: { b: 1 }, group3: { c: 1 } })
+    ).toThrow()
+  })
+})

package/dist/types.js

@@ -87,6 +87,11 @@ var _dsl = require("./queries/dsl");
  * @property {AutoUpdateOptions} [autoUpdate] - Options for the query auto update
  * @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 {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
+ * compatibility but will be set to true in the future.
  */
 
 /**
@@ -303,6 +308,19 @@ var _dsl = require("./queries/dsl");
  * @typedef {IdentityLabel|FamilyLabel|WorkStudyLabels|HealthLabels|HomeLabels|TransportLabels|FinanceLabels|InvoiceLabels|ActivityLabels} ItemsLabels
  */
 
+/**
+ * @typedef {object} DACCMeasure
+ * See https://github.com/cozy/DACC
+ *
+ * @property {string} measureName - It must match an existing measure name on the DACC server
+ * @property {string} startDate - Start of the aggregation period. Should be in YYYY-MM-DD format
+ * @property {number} value - The measured value on the aggregation period
+ * @property {string} createdBy - The slug of the app creating the measure
+ * @property {object} group1 - Should be a {key: value} where the key is set in the measure definition.
+ * @property {object} group2 - Should be a {key: value} where the key is set in the measure definition.
+ * @property {object} group3 - Should be a {key: value} where the key is set in the measure definition.
+ */
+
 /**
  * Receives the URL to present to the user as a parameter, and should return a promise that resolves with the URL the user was redirected to after accepting the permissions.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "27.22.3",
+  "version": "27.25.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -71,5 +71,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "88e40193353972ae7280d31fe8657e874f3ee5c8"
+  "gitHead": "5fdb483852d6bd711dac46ff00734b853d118741"
 }

package/types/hooks/helpers/useIsMounted.d.ts

@@ -0,0 +1,2 @@
+export default useIsMounted;
+declare function useIsMounted(): import("react").MutableRefObject<undefined>;

package/types/hooks/helpers/useSafeState.d.ts

@@ -0,0 +1,2 @@
+export default useSafeState;
+declare function useSafeState(initialState: any): any[];

package/types/hooks/index.d.ts

@@ -4,3 +4,4 @@ export { default as useFetchShortcut } from "./useFetchShortcut";
 export { default as useClient } from "./useClient";
 export { default as useQuery } from "./useQuery";
 export { default as useAppsInMaintenance } from "./useAppsInMaintenance";
+export { default as useQueryAll } from "./useQueryAll";

package/types/hooks/useQuery.d.ts

@@ -2,47 +2,12 @@ export function useQueries(querySpecs: any): {};
 export default useQuery;
 /**
  * Fetches a queryDefinition and returns the queryState
- */
-export type UseQueryOptions = {
-    /**
-     * - Name for the query [required]
-     */
-    as: object;
-    /**
-     * - If set to false, the query won't be executed
-     */
-    enabled: boolean;
-    /**
-     * - Fetch policy
-     */
-    fetchPolicy: object;
-    /**
-     * - 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.
-     */
-    singleDocData: object;
-    /**
-     * - Callback if the query is errored
-     */
-    onError: Function;
-};
-/**
- * Fetches a queryDefinition and returns the queryState
- *
- * @param  {QueryDefinition} queryDefinition - Definition created with Q()
- *
- * @typedef {object} UseQueryOptions
- * @property  {object} as - Name for the query [required]
- * @property  {boolean} enabled - If set to false, the query won't be executed
- * @property  {object} fetchPolicy - Fetch policy
- * @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
- * compatibility but will be set to true in the future.
- * @property {Function} onError - Callback if the query is errored
  *
+ * @param {QueryDefinition} queryDefinition - Definition created with Q()
+ * @param {QueryOptions} options - Options created with Q()
  * @returns {UseQueryReturnValue}
  */
-declare function useQuery(queryDefinition: QueryDefinition, options: any): UseQueryReturnValue;
+declare function useQuery(queryDefinition: QueryDefinition, options: QueryOptions): UseQueryReturnValue;
 import { QueryDefinition } from "../queries/dsl";
+import { QueryOptions } from "../types";
 import { UseQueryReturnValue } from "../types";

package/types/hooks/useQueryAll.d.ts

@@ -0,0 +1,12 @@
+export default useQueryAll;
+/**
+ * Fetches a queryDefinition and run fetchMore on the query until the query is fully loaded
+ *
+ * @param {QueryDefinition} queryDefinition - Definition created with Q()
+ * @param {QueryOptions} options - Options created with Q()
+ * @returns {UseQueryReturnValue}
+ */
+declare function useQueryAll(queryDefinition: QueryDefinition, options: QueryOptions): UseQueryReturnValue;
+import { QueryDefinition } from "../queries/dsl";
+import { QueryOptions } from "../types";
+import { UseQueryReturnValue } from "../types";

package/types/types.d.ts

@@ -68,6 +68,20 @@ export type QueryOptions = {
      * - Callback when the query is errored
      */
     onError?: Function;
+    /**
+     * - If set to false, the query won't be executed
+     */
+    enabled?: boolean;
+    /**
+     * - Whether documents should be returned already hydrated
+     */
+    hydrated?: object;
+    /**
+     * - 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.
+     */
+    singleDocData?: object;
 };
 export type FetchMoreAble = {
     fetchMore: Function;