cozy-client 27.22.1 → 27.23.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.1";
+CozyClient.version = "27.23.0";
 
 _microee.default.mixin(CozyClient);
 

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/document/locales/fr.json

@@ -71,7 +71,7 @@
       "phone_invoice": "Facture de téléphone",
       "isp_invoice": "Facture d'internet",
       "telecom_invoice": "Facture de télécom",
-      "energy_invoice": "Facture d'électricité",
+      "energy_invoice": "Facture d'énergie",
       "water_invoice": "Facture d'eau",
       "web_service_invoice": "Facture de service web",
       "appliance_invoice": "Facture d'électroménager",

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "27.22.1",
+  "version": "27.23.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -47,7 +47,7 @@
     "@cozy/codemods": "1.7.0",
     "@material-ui/core": "4.11.3",
     "@testing-library/react": "10.4.9",
-    "@testing-library/react-hooks": "3.4.2",
+    "@testing-library/react-hooks": "3.7.0",
     "babel-plugin-search-and-replace": "1.1.0",
     "btoa": "1.2.1",
     "cozy-logger": "1.7.0",
@@ -71,5 +71,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "b0652ecd7383d34c8468b492b858049ed0aef10c"
+  "gitHead": "d22e7abb96fe8b3393e3152f631176b0a4eafaeb"
 }

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;