cozy-client 51.6.1 → 51.7.0

package/dist/CozyClient.js

@@ -71,6 +71,8 @@ var _CozyLink = require("./CozyLink");
 
 var _ObservableQuery = _interopRequireDefault(require("./ObservableQuery"));
 
+var _defaultPerformanceApi = require("./performances/defaultPerformanceApi");
+
 var _snapshots = require("./testing/snapshots");
 
 var _logger = _interopRequireDefault(require("./logger"));
@@ -159,6 +161,7 @@ var DOC_UPDATE = 'update';
  * @property  {import("./types").AppMetadata}  [appMetadata] - Metadata about the application that will be used in ensureCozyMetadata
  * @property  {import("./types").ClientCapabilities} [capabilities] - Capabilities sent by the stack
  * @property  {boolean} [store] - If set to false, the client will not instantiate a Redux store automatically. Use this if you want to merge cozy-client's store with your own redux store. See [here](https://docs.cozy.io/en/cozy-client/react-integration/#1b-use-your-own-redux-store) for more information.
+ * @property {import('./performances/types').PerformanceAPI} [performanceApi] - The performance API that can be used to measure performances
  */
 
 /**
@@ -238,12 +241,16 @@ 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"]);
+        performanceApi = rawOptions.performanceApi,
+        _options = (0, _objectWithoutProperties2.default)(rawOptions, ["link", "links", "schema", "appMetadata", "capabilities", "performanceApi"]);
 
     if (link) {
       _logger.default.warn('`link` is deprecated, use `links`');
     }
+    /** @type {import('./performances/types').PerformanceAPI} */
+
 
+    this.performanceApi = performanceApi || _defaultPerformanceApi.defaultPerformanceApi;
     this.appMetadata = appMetadata;
     this.loginPromise = null;
     _options.uri = securiseUri(_options.uri);
@@ -263,7 +270,9 @@ var CozyClient = /*#__PURE__*/function () {
 
       return _this.emit.apply(_this, ['error'].concat(args));
     });
-    this.setLinks(ensureArray(link || links || new _StackLink.default()));
+    this.setLinks(ensureArray(link || links || new _StackLink.default({
+      performanceApi: this.performanceApi
+    })));
     this.schema = new _Schema.default(schema, stackClient);
     /**
      * @type {import("./types").ClientCapabilities}
@@ -1264,6 +1273,7 @@ var CozyClient = /*#__PURE__*/function () {
             update,
             executeFromStore,
             options,
+            markQuery,
             queryId,
             existingQuery,
             shouldFetch,
@@ -1278,53 +1288,54 @@ var CozyClient = /*#__PURE__*/function () {
               case 0:
                 _ref5 = _args8.length > 1 && _args8[1] !== undefined ? _args8[1] : {};
                 update = _ref5.update, executeFromStore = _ref5.executeFromStore, options = (0, _objectWithoutProperties2.default)(_ref5, ["update", "executeFromStore"]);
+                markQuery = this.performanceApi.mark("client.query(".concat(queryDefinition.doctype, ")"));
                 this.ensureStore();
                 queryId = options.as || this.queryIdGenerator.generateId(queryDefinition);
                 existingQuery = this.getQueryFromState(queryId, options);
 
                 if (!(options.enabled !== undefined)) {
-                  _context8.next = 8;
+                  _context8.next = 9;
                   break;
                 }
 
                 if (!('boolean' !== typeof options.enabled)) {
-                  _context8.next = 8;
+                  _context8.next = 9;
                   break;
                 }
 
                 throw new Error("option.enabled should be a boolean for this query: ".concat(JSON.stringify(queryDefinition)));
 
-              case 8:
+              case 9:
                 if (!options.fetchPolicy) {
-                  _context8.next = 14;
+                  _context8.next = 15;
                   break;
                 }
 
                 if (options.as) {
-                  _context8.next = 11;
+                  _context8.next = 12;
                   break;
                 }
 
                 throw new Error('Cannot use `fetchPolicy` without naming the query, please use `as` to name the query');
 
-              case 11:
+              case 12:
                 shouldFetch = options.fetchPolicy(existingQuery);
 
                 if (shouldFetch) {
-                  _context8.next = 14;
+                  _context8.next = 15;
                   break;
                 }
 
                 return _context8.abrupt("return");
 
-              case 14:
+              case 15:
                 if (!(existingQuery && Object.keys(existingQuery).length > 0)) {
-                  _context8.next = 17;
+                  _context8.next = 18;
                   break;
                 }
 
                 if (!(existingQuery.fetchStatus === 'loading')) {
-                  _context8.next = 17;
+                  _context8.next = 18;
                   break;
                 }
 
@@ -1332,9 +1343,9 @@ var CozyClient = /*#__PURE__*/function () {
                   return (0, _jsonStableStringify.default)(queryDefinition);
                 }));
 
-              case 17:
+              case 18:
                 this.ensureQueryExists(queryId, queryDefinition, options);
-                _context8.prev = 18;
+                _context8.prev = 19;
                 backgroundFetching = options.backgroundFetching !== undefined ? options.backgroundFetching : this.options.backgroundFetching;
                 this.dispatch((0, _store.loadQuery)(queryId, {
                   backgroundFetching: backgroundFetching
@@ -1344,53 +1355,63 @@ var CozyClient = /*#__PURE__*/function () {
                 } : function () {
                   return _this4.requestQuery(queryDefinition);
                 };
-                _context8.next = 24;
+                _context8.next = 25;
                 return this._promiseCache.exec(requestFn, function () {
                   return (0, _jsonStableStringify.default)(queryDefinition);
                 });
 
-              case 24:
+              case 25:
                 response = _context8.sent;
                 this.dispatch((0, _store.receiveQueryResult)(queryId, response, {
                   update: update,
                   backgroundFetching: backgroundFetching
                 }));
+                this.performanceApi.measure({
+                  markName: markQuery,
+                  measureName: "".concat(markQuery, " success"),
+                  color: 'primary'
+                });
                 return _context8.abrupt("return", response);
 
-              case 29:
-                _context8.prev = 29;
-                _context8.t0 = _context8["catch"](18);
+              case 31:
+                _context8.prev = 31;
+                _context8.t0 = _context8["catch"](19);
+                this.performanceApi.measure({
+                  markName: markQuery,
+                  measureName: "".concat(markQuery, " error"),
+                  color: 'error'
+                });
                 this.dispatch((0, _store.receiveQueryError)(queryId, _context8.t0)); // specific onError
 
                 if (!options.onError) {
-                  _context8.next = 36;
+                  _context8.next = 39;
                   break;
                 }
 
                 options.onError(_context8.t0); // defaulted onError
 
-                _context8.next = 41;
+                _context8.next = 44;
                 break;
 
-              case 36:
+              case 39:
                 if (!this.options.onError) {
-                  _context8.next = 40;
+                  _context8.next = 43;
                   break;
                 }
 
                 this.options.onError(_context8.t0);
-                _context8.next = 41;
+                _context8.next = 44;
                 break;
 
-              case 40:
+              case 43:
                 throw _context8.t0;
 
-              case 41:
+              case 44:
               case "end":
                 return _context8.stop();
             }
           }
-        }, _callee8, this, [[18, 29]]);
+        }, _callee8, this, [[19, 31]]);
       }));
 
       function query(_x9) {
@@ -2420,7 +2441,7 @@ var CozyClient = /*#__PURE__*/function () {
     key: "ensureStore",
     value: function ensureStore() {
       if (!this.store) {
-        this.setStore((0, _store.createStore)());
+        this.setStore((0, _store.createStore)(this.performanceApi));
       }
     }
     /**
@@ -2552,7 +2573,7 @@ var CozyClient = /*#__PURE__*/function () {
   }, {
     key: "reducer",
     value: function reducer() {
-      return _store.default;
+      return (0, _store.default)(this.performanceApi);
     }
   }, {
     key: "dispatch",
@@ -2708,7 +2729,9 @@ var CozyClient = /*#__PURE__*/function () {
   }, {
     key: "setLinks",
     value: function setLinks(links) {
-      this.links = links ? links : [new _StackLink.default()];
+      this.links = links ? links : [new _StackLink.default({
+        performanceApi: this.performanceApi
+      })];
       this.registerClientOnLinks();
       this.chain = (0, _CozyLink.chain)(this.links);
 
@@ -3026,7 +3049,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 = "51.6.1";
+CozyClient.version = "51.7.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/StackLink.js

@@ -39,6 +39,8 @@ var _logger = _interopRequireDefault(require("./logger"));
 
 var _utils = require("./utils");
 
+var _defaultPerformanceApi = require("./performances/defaultPerformanceApi");
+
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
 
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
@@ -99,6 +101,7 @@ var transformBulkDocsResponse = function transformBulkDocsResponse(bulkResponse,
  * @property {object} [stackClient] - A StackClient
  * @property {object} [client] - A StackClient (deprecated)
  * @property {import('cozy-pouch-link/dist/types').LinkPlatform} [platform] - Platform specific adapters and methods
+ * @property {import('./performances/types').PerformanceAPI} [performanceApi] - The performance API that can be used to measure performances
  */
 
 /**
@@ -122,7 +125,8 @@ var StackLink = /*#__PURE__*/function (_CozyLink) {
     var _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
         client = _ref.client,
         stackClient = _ref.stackClient,
-        platform = _ref.platform;
+        platform = _ref.platform,
+        performanceApi = _ref.performanceApi;
 
     (0, _classCallCheck2.default)(this, StackLink);
     _this = _super.call(this);
@@ -133,6 +137,9 @@ var StackLink = /*#__PURE__*/function (_CozyLink) {
 
     _this.stackClient = stackClient || client;
     _this.isOnline = platform === null || platform === void 0 ? void 0 : platform.isOnline;
+    /** @type {import('./performances/types').PerformanceAPI} */
+
+    _this.performanceApi = performanceApi || _defaultPerformanceApi.defaultPerformanceApi;
     return _this;
   }
 

package/dist/associations.spec.js

@@ -1,5 +1,6 @@
 import CozyClient from './CozyClient'
 import CozyLink from './CozyLink'
+import { defaultPerformanceApi } from './performances/defaultPerformanceApi'
 import { createStore, getQueryFromStore } from './store'
 import { receiveQueryResult, initQuery } from './store/queries'
 
@@ -21,7 +22,7 @@ describe('Associations', () => {
       .shift()
 
   beforeEach(async () => {
-    const store = createStore()
+    const store = createStore(defaultPerformanceApi)
     client.setStore(store, { force: true })
     await store.dispatch(initQuery('allTodos', { doctype: 'io.cozy.todos' }))
     await store.dispatch(

package/dist/index.js

@@ -58,7 +58,9 @@ var _exportNames = {
   withClient: true,
   models: true,
   fetchPolicies: true,
-  BulkEditError: true
+  BulkEditError: true,
+  webPerformanceApi: true,
+  defaultPerformanceApi: true
 };
 Object.defineProperty(exports, "default", {
   enumerable: true,
@@ -360,6 +362,18 @@ Object.defineProperty(exports, "BulkEditError", {
     return _errors.BulkEditError;
   }
 });
+Object.defineProperty(exports, "webPerformanceApi", {
+  enumerable: true,
+  get: function get() {
+    return _webPerformanceApi.webPerformanceApi;
+  }
+});
+Object.defineProperty(exports, "defaultPerformanceApi", {
+  enumerable: true,
+  get: function get() {
+    return _defaultPerformanceApi.defaultPerformanceApi;
+  }
+});
 exports.models = exports.manifest = void 0;
 
 var _CozyClient = _interopRequireDefault(require("./CozyClient"));
@@ -436,4 +450,8 @@ Object.keys(_hooks).forEach(function (key) {
   });
 });
 
-var _errors = require("./errors");
+var _errors = require("./errors");
+
+var _webPerformanceApi = require("./performances/webPerformanceApi");
+
+var _defaultPerformanceApi = require("./performances/defaultPerformanceApi");

package/dist/index.node.js

@@ -38,7 +38,9 @@ var _exportNames = {
   manifest: true,
   BulkEditError: true,
   models: true,
-  fetchPolicies: true
+  fetchPolicies: true,
+  webPerformanceApi: true,
+  defaultPerformanceApi: true
 };
 Object.defineProperty(exports, "default", {
   enumerable: true,
@@ -220,6 +222,18 @@ Object.defineProperty(exports, "fetchPolicies", {
     return _policies.default;
   }
 });
+Object.defineProperty(exports, "webPerformanceApi", {
+  enumerable: true,
+  get: function get() {
+    return _webPerformanceApi.webPerformanceApi;
+  }
+});
+Object.defineProperty(exports, "defaultPerformanceApi", {
+  enumerable: true,
+  get: function get() {
+    return _defaultPerformanceApi.defaultPerformanceApi;
+  }
+});
 exports.models = exports.manifest = void 0;
 
 var _CozyClient = _interopRequireDefault(require("./CozyClient"));
@@ -282,4 +296,8 @@ var models = _interopRequireWildcard(require("./models"));
 
 exports.models = models;
 
-var _policies = _interopRequireDefault(require("./policies"));
+var _policies = _interopRequireDefault(require("./policies"));
+
+var _webPerformanceApi = require("./performances/webPerformanceApi");
+
+var _defaultPerformanceApi = require("./performances/defaultPerformanceApi");

package/dist/performances/defaultPerformanceApi.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.defaultPerformanceApi = void 0;
+
+/** @type {import('./types').PerformanceAPI} */
+var defaultPerformanceApi = {
+  measure: function measure(options) {},
+  mark: function mark(markName) {
+    return markName;
+  }
+};
+exports.defaultPerformanceApi = defaultPerformanceApi;

package/dist/performances/types.js

@@ -0,0 +1,26 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+/**
+ * @typedef {'primary' | 'primary-light' | 'primary-dark' | 'secondary' | 'secondary-light' | 'secondary-dark' | 'tertiary' | 'tertiary-light' | 'tertiary-dark' | 'error'} MeasureColor
+ */
+
+/**
+ * @typedef {object} MeasureOptions
+ * @property {string} markName - Mark name used as the start point for performance measurement
+ * @property {string} [measureName] - Measure name that will be displayed in the performance graph. If not provided, markName will be used by default
+ * @property {string} [category] - Category where the measure will be displayed int he performance graph
+ * @property {MeasureColor} [color] - Category where the measure will be displayed int he performance graph
+ */
+
+/**
+ * @typedef {object} PerformanceAPI
+ * @property {function(MeasureOptions): void} measure
+ * @property {function(string): string} mark
+ */
+var _default = {};
+exports.default = _default;

package/dist/performances/webPerformanceApi.js

@@ -0,0 +1,60 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.webPerformanceApi = void 0;
+
+var _uniqueId = _interopRequireDefault(require("lodash/uniqueId"));
+
+/**
+ * Measure performances since the given markName
+ *
+ * @param {import('./types').MeasureOptions} options - Options for the measurement
+ */
+var measure = function measure(_ref) {
+  var measureName = _ref.measureName,
+      markName = _ref.markName,
+      category = _ref.category,
+      color = _ref.color;
+  var name = measureName !== null && measureName !== void 0 ? measureName : markName; // @ts-ignore
+
+  performance.measure(name, {
+    start: markName,
+    detail: {
+      devtools: {
+        track: category !== null && category !== void 0 ? category : 'CozyClient',
+        color: color !== null && color !== void 0 ? color : 'secondary'
+      }
+    }
+  });
+};
+/**
+ * Set a mark with the given name
+ *
+ * In order to ensure uniqueness of mark names,
+ * the given markName is prefixed with a unique id
+ *
+ * This method returns the computed mark name containing
+ * the unique id. This new ID should be used when
+ * calling `measure()`
+ *
+ * @param {string} markName - the name of the mark
+ */
+
+
+var mark = function mark(markName) {
+  var uniqMarkName = "".concat((0, _uniqueId.default)(), " ").concat(markName);
+  performance.mark(uniqMarkName);
+  return uniqMarkName;
+};
+/** @type {import('./types').PerformanceAPI} */
+
+
+var webPerformanceApi = {
+  measure: measure,
+  mark: mark
+};
+exports.webPerformanceApi = webPerformanceApi;

package/dist/store/index.js

@@ -199,32 +199,57 @@ var initialState = {
   queries: {}
 };
 
-var combinedReducer = function combinedReducer() {
-  var state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : initialState;
-  var action = arguments.length > 1 ? arguments[1] : undefined;
+var combinedReducer = function combinedReducer(performanceApi) {
+  return function () {
+    var state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : initialState;
+    var action = arguments.length > 1 ? arguments[1] : undefined;
+    var markName = performanceApi.mark('combinedReducer');
 
-  if (action.type == RESET_ACTION_TYPE) {
-    return initialState;
-  }
+    if (action.type == RESET_ACTION_TYPE) {
+      performanceApi.measure({
+        markName: markName,
+        measureName: "".concat(markName, " reset"),
+        category: 'CozyClientStore'
+      });
+      return initialState;
+    }
 
-  if (!(0, _queries.isQueryAction)(action) && !(0, _mutations.isMutationAction)(action)) {
-    return state;
-  }
+    if (!(0, _queries.isQueryAction)(action) && !(0, _mutations.isMutationAction)(action)) {
+      performanceApi.measure({
+        markName: markName,
+        measureName: "".concat(markName, " no query nor mutate action"),
+        category: 'CozyClientStore'
+      });
+      return state;
+    }
 
-  if (action.update) {
-    var proxy = new StoreProxy(state);
-    action.update(proxy, action.response);
-    return {
-      documents: proxy.getState().documents,
-      queries: (0, _queries.default)(proxy.getState().queries, action, proxy.getState().documents)
-    };
-  }
+    if (action.update) {
+      var proxy = new StoreProxy(state);
+      action.update(proxy, action.response);
+      var newState = {
+        documents: proxy.getState().documents,
+        queries: (0, _queries.default)(performanceApi, proxy.getState().queries, action, proxy.getState().documents)
+      };
+      performanceApi.measure({
+        markName: markName,
+        measureName: "".concat(markName, " update action"),
+        category: 'CozyClientStore'
+      });
+      return newState;
+    }
 
-  var nextDocuments = (0, _documents.default)(state.documents, action);
-  var haveDocumentsChanged = nextDocuments !== state.documents;
-  return {
-    documents: nextDocuments,
-    queries: (0, _queries.default)(state.queries, action, nextDocuments, haveDocumentsChanged)
+    var nextDocuments = (0, _documents.default)(state.documents, action);
+    var haveDocumentsChanged = nextDocuments !== state.documents;
+    var queriesResult = {
+      documents: nextDocuments,
+      queries: (0, _queries.default)(performanceApi, state.queries, action, nextDocuments, haveDocumentsChanged)
+    };
+    performanceApi.measure({
+      markName: markName,
+      measureName: "".concat(markName, " queries"),
+      category: 'CozyClientStore'
+    });
+    return queriesResult;
   };
 };
 
@@ -236,9 +261,9 @@ var composedEnhancer = // @ts-ignore '__REDUX_DEVTOOLS_EXTENSION_COMPOSE__' does
 // see https://github.com/reduxjs/redux-devtools/tree/main/extension#11-basic-store
 (0, _cozyFlags.default)('debug') && window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__ || _redux.compose;
 
-var createStore = function createStore() {
+var createStore = function createStore(performanceApi) {
   return (0, _redux.createStore)((0, _redux.combineReducers)({
-    cozy: combinedReducer
+    cozy: combinedReducer(performanceApi)
   }), composedEnhancer((0, _redux.applyMiddleware)(_reduxThunk.default)));
 };
 

package/dist/store/queries.js

@@ -167,6 +167,7 @@ var updateQueryDataFromResponse = function updateQueryDataFromResponse(queryStat
 /**
  * Reducer for a query slice
  *
+ * @param  {import('../performances/types').PerformanceAPI} performanceApi - The performance API that can be used to measure performances
  * @param  {import("../types").QueryState} state - Current state
  * @param  {any} action - Redux action
  * @param  {import("../types").DocumentsStateSlice} documents - Reference to the next documents slice
@@ -174,10 +175,10 @@ var updateQueryDataFromResponse = function updateQueryDataFromResponse(queryStat
  */
 
 
-var query = function query() {
-  var state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : queryInitialState;
-  var action = arguments.length > 1 ? arguments[1] : undefined;
-  var documents = arguments.length > 2 ? arguments[2] : undefined;
+var query = function query(performanceApi) {
+  var state = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : queryInitialState;
+  var action = arguments.length > 2 ? arguments[2] : undefined;
+  var documents = arguments.length > 3 ? arguments[3] : undefined;
 
   switch (action.type) {
     case INIT_QUERY:
@@ -210,11 +211,17 @@ var query = function query() {
 
     case RECEIVE_QUERY_RESULT:
       {
+        var markName = performanceApi.mark('RECEIVE_QUERY_RESULT');
         var response = action.response; // Data can be null when we get a 404 not found
         // see Collection.get()
         // but we still need to update the fetchStatus.
 
         if (!response.data) {
+          performanceApi.measure({
+            markName: markName,
+            measureName: "".concat(markName, " with no data"),
+            category: 'CozyClientStore'
+          });
           return _objectSpread(_objectSpread({}, state), {}, {
             fetchStatus: 'loaded',
             isFetching: action.backgroundFetching ? false : null,
@@ -235,6 +242,11 @@ var query = function query() {
         });
 
         if (!Array.isArray(response.data)) {
+          performanceApi.measure({
+            markName: markName,
+            measureName: "".concat(markName, " with object"),
+            category: 'CozyClientStore'
+          });
           return _objectSpread(_objectSpread(_objectSpread({}, state), common), {}, {
             hasMore: false,
             count: 1,
@@ -245,6 +257,11 @@ var query = function query() {
         var count = response.meta && response.meta.count ? response.meta.count : response.data.length;
 
         if (action.backgroundFetching) {
+          performanceApi.measure({
+            markName: markName,
+            measureName: "".concat(markName, " with background fetching"),
+            category: 'CozyClientStore'
+          });
           return _objectSpread(_objectSpread(_objectSpread({}, state), common), {}, {
             bookmark: response.bookmark || null,
             hasMore: response.next !== undefined ? response.next : state.hasMore,
@@ -258,6 +275,11 @@ var query = function query() {
           count: count,
           fetchedPagesCount: fetchedPagesCount
         });
+        performanceApi.measure({
+          markName: markName,
+          measureName: "".concat(markName, " default"),
+          category: 'CozyClientStore'
+        });
         return _objectSpread(_objectSpread(_objectSpread({}, state), common), {}, {
           bookmark: response.bookmark || null,
           hasMore: response.next !== undefined ? response.next : state.hasMore,
@@ -575,6 +597,7 @@ var manualQueryUpdater = function manualQueryUpdater(action, documents) {
   };
 };
 /**
+ * @param  {import('../performances/types').PerformanceAPI} performanceApi - The performance API that can be used to measure performances
  * @param  {import("../types").QueriesStateSlice}  state - Redux slice containing all the query states indexed by name
  * @param  {object}  action - Income redux action
  * @param  {import("../types").DocumentsStateSlice}  documents - Reference to documents slice
@@ -583,14 +606,14 @@ var manualQueryUpdater = function manualQueryUpdater(action, documents) {
  */
 
 
-var queries = function queries() {
-  var state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  var action = arguments.length > 1 ? arguments[1] : undefined;
-  var documents = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
-  var haveDocumentsChanged = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : true;
+var queries = function queries(performanceApi) {
+  var state = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  var action = arguments.length > 2 ? arguments[2] : undefined;
+  var documents = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
+  var haveDocumentsChanged = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : true;
 
   if (action.type == INIT_QUERY) {
-    var newQueryState = query(state[action.queryId], action, documents); // Do not create new object unnecessarily
+    var newQueryState = query(performanceApi, state[action.queryId], action, documents); // Do not create new object unnecessarily
 
     if (newQueryState === state[action.queryId]) {
       return state;
@@ -603,7 +626,7 @@ var queries = function queries() {
     var updater = autoQueryUpdater(action, documents);
     return (0, _mapValues.default)(state, function (queryState) {
       if (queryState.id == action.queryId) {
-        return query(queryState, action, documents);
+        return query(performanceApi, queryState, action, documents);
       } else if (haveDocumentsChanged) {
         return updater(queryState);
       } else {

package/dist/store/queries.spec.js

@@ -1,3 +1,4 @@
+import { defaultPerformanceApi } from '../performances/defaultPerformanceApi'
 import queries, {
   initQuery,
   receiveQueryResult,
@@ -19,7 +20,7 @@ describe('queries reducer', () => {
     data: [TODO_1, TODO_2]
   }
   const applyAction = action => {
-    state = queries(state, action)
+    state = queries(defaultPerformanceApi, state, action)
   }
   beforeEach(() => {
     state = {}

package/dist/store.spec.js

@@ -1,6 +1,7 @@
 import { createStore, combineReducers } from 'redux'
 import sortBy from 'lodash/sortBy'
 
+import { defaultPerformanceApi } from './performances/defaultPerformanceApi'
 import reducer, {
   initQuery,
   getCollectionFromState,
@@ -25,7 +26,9 @@ import {
 describe('Store', () => {
   let store
   beforeEach(() => {
-    store = createStore(combineReducers({ cozy: reducer }))
+    store = createStore(
+      combineReducers({ cozy: reducer(defaultPerformanceApi) })
+    )
   })
 
   describe('documents state', () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "51.6.1",
+  "version": "51.7.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -72,5 +72,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "b46c9c9248b140429972790624fa46b1b547226f"
+  "gitHead": "86418c696e22dcf873aa9d84ed195253ec058783"
 }

package/types/CozyClient.d.ts

@@ -76,6 +76,10 @@ export type ClientOptions = {
      * - If set to false, the client will not instantiate a Redux store automatically. Use this if you want to merge cozy-client's store with your own redux store. See [here](https://docs.cozy.io/en/cozy-client/react-integration/#1b-use-your-own-redux-store) for more information.
      */
     store?: boolean;
+    /**
+     * - The performance API that can be used to measure performances
+     */
+    performanceApi?: import('./performances/types').PerformanceAPI;
 };
 /**
  * @typedef {import("./types").CozyClientDocument} CozyClientDocument
@@ -99,6 +103,7 @@ export type ClientOptions = {
  * @property  {import("./types").AppMetadata}  [appMetadata] - Metadata about the application that will be used in ensureCozyMetadata
  * @property  {import("./types").ClientCapabilities} [capabilities] - Capabilities sent by the stack
  * @property  {boolean} [store] - If set to false, the client will not instantiate a Redux store automatically. Use this if you want to merge cozy-client's store with your own redux store. See [here](https://docs.cozy.io/en/cozy-client/react-integration/#1b-use-your-own-redux-store) for more information.
+ * @property {import('./performances/types').PerformanceAPI} [performanceApi] - The performance API that can be used to measure performances
  */
 /**
  * Responsible for
@@ -189,6 +194,8 @@ declare class CozyClient {
      * Cozy-Client will automatically call `this.login()` if provided with a token and an uri
      */
     constructor(rawOptions?: ClientOptions);
+    /** @type {import('./performances/types').PerformanceAPI} */
+    performanceApi: import('./performances/types').PerformanceAPI;
     appMetadata: import("./types").AppMetadata;
     loginPromise: Promise<void>;
     options: {

package/types/StackLink.d.ts

@@ -6,6 +6,7 @@ export function transformBulkDocsResponse(bulkResponse: import("./types").CouchD
  * @property {object} [stackClient] - A StackClient
  * @property {object} [client] - A StackClient (deprecated)
  * @property {import('cozy-pouch-link/dist/types').LinkPlatform} [platform] - Platform specific adapters and methods
+ * @property {import('./performances/types').PerformanceAPI} [performanceApi] - The performance API that can be used to measure performances
  */
 /**
  * Transfers queries and mutations to a remote stack
@@ -14,9 +15,11 @@ export default class StackLink extends CozyLink {
     /**
      * @param {StackLinkOptions} [options] - Options
      */
-    constructor({ client, stackClient, platform }?: StackLinkOptions);
+    constructor({ client, stackClient, platform, performanceApi }?: StackLinkOptions);
     stackClient: any;
     isOnline: any;
+    /** @type {import('./performances/types').PerformanceAPI} */
+    performanceApi: import('./performances/types').PerformanceAPI;
     registerClient(client: any): void;
     /**
      *
@@ -39,6 +42,10 @@ export type StackLinkOptions = {
      * - Platform specific adapters and methods
      */
     platform?: any;
+    /**
+     * - The performance API that can be used to measure performances
+     */
+    performanceApi?: import('./performances/types').PerformanceAPI;
 };
 import CozyLink from "./CozyLink";
 import { QueryDefinition } from "./queries/dsl";

package/types/index.d.ts

@@ -13,6 +13,8 @@ export { default as fetchPolicies } from "./policies";
 export * from "./mock";
 export * from "./hooks";
 export { BulkEditError } from "./errors";
+export { webPerformanceApi } from "./performances/webPerformanceApi";
+export { defaultPerformanceApi } from "./performances/defaultPerformanceApi";
 import * as manifest from "./models/manifest";
 import * as models from "./models";
 export { manifest, models };

package/types/index.node.d.ts

@@ -10,6 +10,8 @@ export * from "./mock";
 export * from "./cli";
 export { BulkEditError } from "./errors";
 export { default as fetchPolicies } from "./policies";
+export { webPerformanceApi } from "./performances/webPerformanceApi";
+export { defaultPerformanceApi } from "./performances/defaultPerformanceApi";
 import * as manifest from "./models/manifest";
 import * as models from "./models";
 export { manifest, models };

package/types/performances/defaultPerformanceApi.d.ts

@@ -0,0 +1,2 @@
+/** @type {import('./types').PerformanceAPI} */
+export const defaultPerformanceApi: import('./types').PerformanceAPI;

package/types/performances/types.d.ts

@@ -0,0 +1,25 @@
+declare var _default: {};
+export default _default;
+export type MeasureColor = "error" | "primary" | "primary-light" | "primary-dark" | "secondary" | "secondary-light" | "secondary-dark" | "tertiary" | "tertiary-light" | "tertiary-dark";
+export type MeasureOptions = {
+    /**
+     * - Mark name used as the start point for performance measurement
+     */
+    markName: string;
+    /**
+     * - Measure name that will be displayed in the performance graph. If not provided, markName will be used by default
+     */
+    measureName?: string;
+    /**
+     * - Category where the measure will be displayed int he performance graph
+     */
+    category?: string;
+    /**
+     * - Category where the measure will be displayed int he performance graph
+     */
+    color?: MeasureColor;
+};
+export type PerformanceAPI = {
+    measure: (arg0: MeasureOptions) => void;
+    mark: (arg0: string) => string;
+};

package/types/performances/webPerformanceApi.d.ts

@@ -0,0 +1,2 @@
+/** @type {import('./types').PerformanceAPI} */
+export const webPerformanceApi: import('./types').PerformanceAPI;

package/types/store/index.d.ts

@@ -7,11 +7,11 @@ export class StoreProxy {
     getState(): any;
 }
 export default combinedReducer;
-export function createStore(): any;
-declare function combinedReducer(state: {
+export function createStore(performanceApi: any): any;
+declare function combinedReducer(performanceApi: any): (state: {
     documents: {};
     queries: {};
-}, action: any): {
+}, action: any) => {
     documents: any;
     queries: Record<string, import("../types").QueryState>;
 };

package/types/store/queries.d.ts

@@ -39,10 +39,11 @@ export namespace QueryIDGenerator {
 }
 import { QueryDefinition } from "../queries/dsl";
 /**
+ * @param  {import('../performances/types').PerformanceAPI} performanceApi - The performance API that can be used to measure performances
  * @param  {import("../types").QueriesStateSlice}  state - Redux slice containing all the query states indexed by name
  * @param  {object}  action - Income redux action
  * @param  {import("../types").DocumentsStateSlice}  documents - Reference to documents slice
  * @param  {boolean} haveDocumentsChanged - Has the document slice changed with current action
  * @returns {import("../types").QueriesStateSlice}
  */
-declare function queries(state: import("../types").QueriesStateSlice, action: object, documents?: import("../types").DocumentsStateSlice, haveDocumentsChanged?: boolean): import("../types").QueriesStateSlice;
+declare function queries(performanceApi: import('../performances/types').PerformanceAPI, state: import("../types").QueriesStateSlice, action: object, documents?: import("../types").DocumentsStateSlice, haveDocumentsChanged?: boolean): import("../types").QueriesStateSlice;