cozy-harvest-lib 9.23.2 → 9.23.3

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [9.23.3](https://github.com/cozy/cozy-libs/compare/cozy-harvest-lib@9.23.2...cozy-harvest-lib@9.23.3) (2022-07-27)
+
+
+### Bug Fixes
+
+* Add ts-check on biWebview ([1920474](https://github.com/cozy/cozy-libs/commit/1920474b85ad342adbd12a363612918db1665bca))
+
+
+
+
+
 ## [9.23.2](https://github.com/cozy/cozy-libs/compare/cozy-harvest-lib@9.23.1...cozy-harvest-lib@9.23.2) (2022-07-26)
 
 

package/dist/services/biWebView.js

@@ -16,6 +16,7 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
 import _regeneratorRuntime from "@babel/runtime/regenerator";
+// @ts-check
 
 /**
  * Interface between Budget Insight and Cozy using BI's webview
@@ -25,13 +26,20 @@ import _regeneratorRuntime from "@babel/runtime/regenerator";
 import { getBIConnection, getBIConnectionAccountsList } from './bi-http';
 import assert from '../assert';
 import logger from '../logger';
-import { Q } from 'cozy-client';
+import { Q } from 'cozy-client'; // @ts-ignore (its a peerDep and I don't know how to configure ts for that)
+
 import flag from 'cozy-flags';
 import { setBIConnectionId, saveBIConfig, findAccountWithBiConnection, convertBIErrortoKonnectorJobError, isBudgetInsightConnector, getBIConnectionIdFromAccount } from './budget-insight';
 import { KonnectorJobError } from '../helpers/konnectors';
 import { waitForRealtimeEvent } from './jobUtils';
 import '../types';
 import { LOGIN_SUCCESS_EVENT } from '../models/flowEvents';
+/**
+ * @typedef {import("../models/ConnectionFlow").default} ConnectionFlow
+ * @typedef {object} CozyClient
+
+ */
+
 var TEMP_TOKEN_TIMOUT_S = 60;
 export var ACCOUNTS_DOCTYPE = 'io.cozy.accounts';
 export var isBiWebViewConnector = function isBiWebViewConnector(konnector) {
@@ -39,13 +47,13 @@ export var isBiWebViewConnector = function isBiWebViewConnector(konnector) {
 };
 /**
  * Runs multiple checks on the bi connection referenced in the given account
- *
- * @param {io.cozy.accounts} options.account The account content
- * @param {ConnectionFlow} options.flow
- * @param {io.cozy.konnectors} options.konnector connector manifest content
+ * @param {object} options
+ * @param {IoCozyAccount} options.account The account content
+ * @param {KonnectorManifest} options.konnector konnector manifest content
+ * @param {ConnectionFlow} options.flow The flow
  * @param {CozyClient} options.client CozyClient object
  *
- * @return {Integer} Connection Id
+ * @return {Promise<biConnection>} Connection Id
  */
 
 export var checkBIConnection = /*#__PURE__*/function () {
@@ -89,28 +97,27 @@ export var checkBIConnection = /*#__PURE__*/function () {
             sameAccount = _context.sent;
 
             if (!sameAccount) {
-              _context.next = 22;
+              _context.next = 21;
               break;
             }
 
             err = new KonnectorJobError('ACCOUNT_WITH_SAME_IDENTIFIER_ALREADY_DEFINED');
-            err.accountId = sameAccount._id;
             throw err;
 
-          case 22:
+          case 21:
             return _context.abrupt("return", connection);
 
-          case 25:
-            _context.prev = 25;
+          case 24:
+            _context.prev = 24;
             _context.t0 = _context["catch"](1);
             return _context.abrupt("return", convertBIErrortoKonnectorJobError(_context.t0));
 
-          case 28:
+          case 27:
           case "end":
             return _context.stop();
         }
       }
-    }, _callee, null, [[1, 25]]);
+    }, _callee, null, [[1, 24]]);
   }));
 
   return function checkBIConnection(_x) {
@@ -156,12 +163,14 @@ export var fetchContractSynchronizationUrl = /*#__PURE__*/function () {
 /**
  * Handles webview connection
  *
- * @param {io.cozy.accounts} options.account The account content
- * @param {ConnectionFlow} options.flow
- * @param {io.cozy.konnectors} options.konnector connector manifest content
+ * @param {object} options
+ * @param {IoCozyAccount} options.account The account content
+ * @param {KonnectorManifest} options.konnector konnector manifest content
+ * @param {ConnectionFlow} options.flow The flow
  * @param {CozyClient} options.client CozyClient object
- *
- * @return {Integer} Connection Id
+ * @param {Boolean} options.reconnect If this is a reconnexion
+ * @param {Function} options.t Translation fonction
+ * @return {Promise<Number>} Connection Id
  */
 
 export var handleOAuthAccount = /*#__PURE__*/function () {
@@ -232,7 +241,7 @@ export var handleOAuthAccount = /*#__PURE__*/function () {
 /**
  * Return the bi aggregator parent relationship configuration for a given konnector
  *
- * @param {io.cozy.konnectors} konnector connector manifest content
+ * @param {KonnectorManifest} konnector connector manifest content
  *
  * @return {Object}
  */
@@ -261,9 +270,9 @@ var getBiAggregatorParentRelationship = function getBiAggregatorParentRelationsh
  * Gets BI webview connection id which is returned in the account by the stack
  * via oauth callback url
  *
- * @param {io.cozy.accounts} The account content created by the stack
+ * @param {IoCozyAccount} account The account content created by the stack
  *
- * @return {Integer} Connection Id
+ * @return {Number|null} Connection Id or null if no connexion
  */
 
 
@@ -274,13 +283,13 @@ var getWebviewBIConnectionId = function getWebviewBIConnectionId(account) {
 };
 /**
  * Hook from ConnectionFlow after account creation
- *
- * @param {io.cozy.accounts} options.account - created account
- * @param {io.cozy.konnectors} options.konnector  - manifest of the konnector for which the account is created
+ * @param {object} options
+ * @param {IoCozyAccount} options.account - created account
+ * @param {KonnectorManifest} options.konnector konnector manifest content
  * @param {ConnectionFlow} options.flow - current ConnectionFlow instance
  * @param {CozyClient} options.client - current CozyClient instance
  *
- * @returns {Promise<io.cozy.accounts>}
+ * @returns {Promise<IoCozyAccount>}
  */
 
 
@@ -334,59 +343,43 @@ export var onBIAccountCreation = /*#__PURE__*/function () {
 }();
 /**
  * Create OAuth extra parameters specific to reconnect webview
- *
- * @param {Array<Number>} options.biBankIds - connector bank ids (for webview connectors)
+ * @param {object} options
+ * @param {Array<String>} options.biBankIds - connector bank ids (for webview connectors)
  * @param {String} options.token - BI temporary token
  * @param {Number} options.connId - BI bi connection id
  * @return {Object}
  */
 
-var getReconnectExtraOAuthUrlParams = /*#__PURE__*/function () {
-  var _ref10 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee5(_ref9) {
-    var biBankIds, token, connId;
-    return _regeneratorRuntime.wrap(function _callee5$(_context5) {
-      while (1) {
-        switch (_context5.prev = _context5.next) {
-          case 0:
-            biBankIds = _ref9.biBankIds, token = _ref9.token, connId = _ref9.connId;
-            return _context5.abrupt("return", {
-              id_connector: biBankIds,
-              code: token,
-              connection_id: connId
-            });
-
-          case 2:
-          case "end":
-            return _context5.stop();
-        }
-      }
-    }, _callee5);
-  }));
-
-  return function getReconnectExtraOAuthUrlParams(_x5) {
-    return _ref10.apply(this, arguments);
+var getReconnectExtraOAuthUrlParams = function getReconnectExtraOAuthUrlParams(_ref9) {
+  var biBankIds = _ref9.biBankIds,
+      token = _ref9.token,
+      connId = _ref9.connId;
+  return {
+    id_connector: biBankIds,
+    code: token,
+    connection_id: connId
   };
-}();
+};
 /**
  * Create OAuth extra parameters
- *
+ * @param {object} options
  * @param {CozyClient} options.client - CozyClient instance
- * @param {io.cozy.konnectors} options.konnector connector manifest content
- * @param {io.cozy.accounts} options.account The account content
+ * @param {KonnectorManifest} options.konnector konnector manifest content
+ * @param {IoCozyAccount} options.account The account content
  * @return {Promise<Object>}
  */
 
 
 export var fetchExtraOAuthUrlParams = /*#__PURE__*/function () {
-  var _ref12 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee6(_ref11) {
+  var _ref11 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee5(_ref10) {
     var client, konnector, account, _yield$createTemporar2, token, biBankIds, connId, isReconnect;
 
-    return _regeneratorRuntime.wrap(function _callee6$(_context6) {
+    return _regeneratorRuntime.wrap(function _callee5$(_context5) {
       while (1) {
-        switch (_context6.prev = _context6.next) {
+        switch (_context5.prev = _context5.next) {
           case 0:
-            client = _ref11.client, konnector = _ref11.konnector, account = _ref11.account;
-            _context6.next = 3;
+            client = _ref10.client, konnector = _ref10.konnector, account = _ref10.account;
+            _context5.next = 3;
             return createTemporaryToken({
               client: client,
               konnector: konnector,
@@ -394,54 +387,54 @@ export var fetchExtraOAuthUrlParams = /*#__PURE__*/function () {
             });
 
           case 3:
-            _yield$createTemporar2 = _context6.sent;
+            _yield$createTemporar2 = _context5.sent;
             token = _yield$createTemporar2.code;
             biBankIds = _yield$createTemporar2.biBankIds;
             connId = getBIConnectionIdFromAccount(account);
             isReconnect = Boolean(connId);
 
             if (!isReconnect) {
-              _context6.next = 12;
+              _context5.next = 12;
               break;
             }
 
-            return _context6.abrupt("return", getReconnectExtraOAuthUrlParams({
+            return _context5.abrupt("return", getReconnectExtraOAuthUrlParams({
               biBankIds: biBankIds,
               token: token,
               connId: connId
             }));
 
           case 12:
-            return _context6.abrupt("return", {
+            return _context5.abrupt("return", {
               id_connector: biBankIds,
               token: token
             });
 
           case 13:
           case "end":
-            return _context6.stop();
+            return _context5.stop();
         }
       }
-    }, _callee6);
+    }, _callee5);
   }));
 
-  return function fetchExtraOAuthUrlParams(_x6) {
-    return _ref12.apply(this, arguments);
+  return function fetchExtraOAuthUrlParams(_x5) {
+    return _ref11.apply(this, arguments);
   };
 }();
 /**
  * Finds the current bankIid in a given konnector or account
- *
- * @param {io.cozy.accounts} options.account The account content
- * @param {io.cozy.konnectors} options.konnector connector manifest content
+ * @param {object} options
+ * @param {IoCozyAccount} options.account The account content
+ * @param {KonnectorManifest} options.konnector konnector manifest content
  * @return {Array<String>} - list of bank ids
  */
 
-export var getCozyBankIds = function getCozyBankIds(_ref13) {
+export var getCozyBankIds = function getCozyBankIds(_ref12) {
   var _konnector$parameters, _account$auth, _konnector$fields, _konnector$fields$ban;
 
-  var konnector = _ref13.konnector,
-      account = _ref13.account;
+  var konnector = _ref12.konnector,
+      account = _ref12.account;
   var cozyBankId = (konnector === null || konnector === void 0 ? void 0 : (_konnector$parameters = konnector.parameters) === null || _konnector$parameters === void 0 ? void 0 : _konnector$parameters.bankId) || (account === null || account === void 0 ? void 0 : (_account$auth = account.auth) === null || _account$auth === void 0 ? void 0 : _account$auth.bankId);
 
   if (cozyBankId) {
@@ -460,24 +453,24 @@ export var getCozyBankIds = function getCozyBankIds(_ref13) {
 };
 /**
  * Update imported state of contracts in the given account, according to current state of the accounts on the BI side.
- *
+ * @param {object} options
  * @param {CozyClient} options.client - CozyClient instance
- * @param {io.cozy.accounts} options.account The account content
- * @param {io.cozy.konnectors} options.konnector connector manifest content
+ * @param {IoCozyAccount} options.account The account content
+ * @param {KonnectorManifest} options.konnector konnector manifest content
  */
 
 export var refreshContracts = /*#__PURE__*/function () {
-  var _ref15 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee7(_ref14) {
+  var _ref14 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee6(_ref13) {
     var _account$relationship, _account$relationship2;
 
     var client, konnector, account, biConfig, code, config, connectionId, _yield$getBIConnectio, contracts, contractsById, currentContractsList, _iterator, _step, currentContract, disabledValue;
 
-    return _regeneratorRuntime.wrap(function _callee7$(_context7) {
+    return _regeneratorRuntime.wrap(function _callee6$(_context6) {
       while (1) {
-        switch (_context7.prev = _context7.next) {
+        switch (_context6.prev = _context6.next) {
           case 0:
-            client = _ref14.client, konnector = _ref14.konnector, account = _ref14.account;
-            _context7.next = 3;
+            client = _ref13.client, konnector = _ref13.konnector, account = _ref13.account;
+            _context6.next = 3;
             return createTemporaryToken({
               client: client,
               konnector: konnector,
@@ -485,14 +478,14 @@ export var refreshContracts = /*#__PURE__*/function () {
             });
 
           case 3:
-            biConfig = _context7.sent;
+            biConfig = _context6.sent;
             code = biConfig.code, config = _objectWithoutProperties(biConfig, _excluded2);
             connectionId = getWebviewBIConnectionId(account);
-            _context7.next = 8;
+            _context6.next = 8;
             return getBIConnectionAccountsList(config, connectionId, code);
 
           case 8:
-            _yield$getBIConnectio = _context7.sent;
+            _yield$getBIConnectio = _context6.sent;
             contracts = _yield$getBIConnectio.accounts;
             contractsById = contracts.reduce(function (memo, contract) {
               return _objectSpread(_objectSpread({}, memo), {}, _defineProperty({}, contract.id + '', contract.disabled));
@@ -513,19 +506,19 @@ export var refreshContracts = /*#__PURE__*/function () {
               _iterator.f();
             }
 
-            _context7.next = 16;
+            _context6.next = 16;
             return client.save(account);
 
           case 16:
           case "end":
-            return _context7.stop();
+            return _context6.stop();
         }
       }
-    }, _callee7);
+    }, _callee6);
   }));
 
-  return function refreshContracts(_x7) {
-    return _ref15.apply(this, arguments);
+  return function refreshContracts(_x6) {
+    return _ref14.apply(this, arguments);
   };
 }();
 
@@ -536,49 +529,47 @@ function convertBIDateToStandardDate(biDate) {
  * Get the BI temporary token cache from Cozy doctype
  *
  * @param {CozyClient} options.client CozyClient instance
- * @return {createTemporaryTokenResponse}
+ * @return {Promise<createTemporaryTokenResponse>}
  */
 
 
-function getBiTemporaryTokenFromCache(_x8) {
+function getBiTemporaryTokenFromCache(_x7) {
   return _getBiTemporaryTokenFromCache.apply(this, arguments);
 }
 /**
  * Check if BI temporary token cache is expired or not
- *
- * @param {createTemporaryTokenResponse} options.tokenCache
+ * @param {createTemporaryTokenResponse} tokenCache
+ * @param {Object} biUser the bi user
  * @return {Boolean}
  */
 
 
 function _getBiTemporaryTokenFromCache() {
-  _getBiTemporaryTokenFromCache = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee9(_ref16) {
+  _getBiTemporaryTokenFromCache = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee8(_ref15) {
     var client, queryResult;
-    return _regeneratorRuntime.wrap(function _callee9$(_context9) {
+    return _regeneratorRuntime.wrap(function _callee8$(_context8) {
       while (1) {
-        switch (_context9.prev = _context9.next) {
+        switch (_context8.prev = _context8.next) {
           case 0:
-            client = _ref16.client;
-            _context9.next = 3;
+            client = _ref15.client;
+            _context8.next = 3;
             return client.query(Q('io.cozy.bank.settings').getById('bi'));
 
           case 3:
-            queryResult = _context9.sent;
-            return _context9.abrupt("return", (queryResult === null || queryResult === void 0 ? void 0 : queryResult.data) || {});
+            queryResult = _context8.sent;
+            return _context8.abrupt("return", (queryResult === null || queryResult === void 0 ? void 0 : queryResult.data) || {});
 
           case 5:
           case "end":
-            return _context9.stop();
+            return _context8.stop();
         }
       }
-    }, _callee9);
+    }, _callee8);
   }));
   return _getBiTemporaryTokenFromCache.apply(this, arguments);
 }
 
-export function isCacheExpired(_ref17) {
-  var tokenCache = _ref17.tokenCache,
-      biUser = _ref17.biUser;
+export function isCacheExpired(tokenCache, biUser) {
   var cacheAge = Date.now() - Number(tokenCache === null || tokenCache === void 0 ? void 0 : tokenCache.timestamp);
   logger.debug('tokenCache age', cacheAge / 1000 / 60, 'minutes');
   var MAX_TOKEN_CACHE_AGE = 29 * 60 * 1000;
@@ -596,37 +587,37 @@ export function isCacheExpired(_ref17) {
 }
 /**
  * Update the BI temporary token cache from BI itself
- *
+ * @param {object} options
  * @param {CozyClient} options.client CozyClient instance
- * @param {io.cozy.konnectors} options.konnector
- * @param {Array<Number>} options.cozyBankIds List of cozy bank identifiers
+ * @param {KonnectorManifest} options.konnector konnector manifest content
+ * @param {Array<String>} options.cozyBankIds List of cozy bank identifiers
  * @param {createTemporaryTokenResponse} options.tokenCache Previous version of BI temporary token cache
- * @return {createTemporaryTokenResponse}
+ * @return {Promise<createTemporaryTokenResponse>}
  */
 
-function updateCache(_x9) {
+function updateCache(_x8) {
   return _updateCache.apply(this, arguments);
 }
 /**
  * Gets a temporary token corresponding to the current BI user
- *
+ * @param {object} options
  * @param {CozyClient} options.client - CozyClient instance
- * @param {io.cozy.konnectors} options.konnector connector manifest content
- * @param {io.cozy.accounts} options.account The account content
+ * @param {KonnectorManifest} options.konnector konnector manifest content
+ * @param {IoCozyAccount} options.account The account content
  *
- * @returns {createTemporaryTokenResponse}
+ * @returns {Promise<createTemporaryTokenResponse>}
  */
 
 
 function _updateCache() {
-  _updateCache = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee10(_ref18) {
+  _updateCache = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee9(_ref16) {
     var client, konnector, tokenCache, cozyBankIds, jobResponse, event, saveResult;
-    return _regeneratorRuntime.wrap(function _callee10$(_context10) {
+    return _regeneratorRuntime.wrap(function _callee9$(_context9) {
       while (1) {
-        switch (_context10.prev = _context10.next) {
+        switch (_context9.prev = _context9.next) {
           case 0:
-            client = _ref18.client, konnector = _ref18.konnector, tokenCache = _ref18.tokenCache, cozyBankIds = _ref18.cozyBankIds;
-            _context10.next = 3;
+            client = _ref16.client, konnector = _ref16.konnector, tokenCache = _ref16.tokenCache, cozyBankIds = _ref16.cozyBankIds;
+            _context9.next = 3;
             return client.stackClient.jobs.create('konnector', {
               mode: 'getTemporaryToken',
               konnector: konnector.slug,
@@ -634,13 +625,13 @@ function _updateCache() {
             }, {}, true);
 
           case 3:
-            jobResponse = _context10.sent;
-            _context10.next = 6;
+            jobResponse = _context9.sent;
+            _context9.next = 6;
             return waitForRealtimeEvent(client, jobResponse.data.attributes, 'result', TEMP_TOKEN_TIMOUT_S * 1000);
 
           case 6:
-            event = _context10.sent;
-            _context10.next = 9;
+            event = _context9.sent;
+            _context9.next = 9;
             return client.save(_objectSpread(_objectSpread({
               _type: 'io.cozy.bank.settings',
               _id: 'bi'
@@ -651,59 +642,56 @@ function _updateCache() {
             }, event.data.result));
 
           case 9:
-            saveResult = _context10.sent;
-            return _context10.abrupt("return", saveResult.data);
+            saveResult = _context9.sent;
+            return _context9.abrupt("return", saveResult.data);
 
           case 11:
           case "end":
-            return _context10.stop();
+            return _context9.stop();
         }
       }
-    }, _callee10);
+    }, _callee9);
   }));
   return _updateCache.apply(this, arguments);
 }
 
 export var createTemporaryToken = /*#__PURE__*/function () {
-  var _ref20 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee8(_ref19) {
+  var _ref18 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee7(_ref17) {
     var _tokenCache;
 
     var client, konnector, account, tokenCache, cozyBankIds, _yield$client$query, biUser, _tokenCache2, biMapping;
 
-    return _regeneratorRuntime.wrap(function _callee8$(_context8) {
+    return _regeneratorRuntime.wrap(function _callee7$(_context7) {
       while (1) {
-        switch (_context8.prev = _context8.next) {
+        switch (_context7.prev = _context7.next) {
           case 0:
-            client = _ref19.client, konnector = _ref19.konnector, account = _ref19.account;
+            client = _ref17.client, konnector = _ref17.konnector, account = _ref17.account;
             assert(konnector.slug, 'createTemporaryToken: konnector passed in options has no slug');
-            _context8.next = 4;
+            _context7.next = 4;
             return getBiTemporaryTokenFromCache({
               client: client
             });
 
           case 4:
-            tokenCache = _context8.sent;
+            tokenCache = _context7.sent;
             cozyBankIds = getCozyBankIds({
               konnector: konnector,
               account: account
             });
-            _context8.next = 8;
+            _context7.next = 8;
             return client.query(Q('io.cozy.accounts').getById('bi-aggregator-user'));
 
           case 8:
-            _yield$client$query = _context8.sent;
+            _yield$client$query = _context7.sent;
             biUser = _yield$client$query.data;
 
-            if (!isCacheExpired({
-              tokenCache: tokenCache,
-              biUser: biUser
-            })) {
-              _context8.next = 15;
+            if (!isCacheExpired(tokenCache, biUser)) {
+              _context7.next = 15;
               break;
             }
 
             logger.debug('temporaryToken cache is expired. Updating');
-            _context8.next = 14;
+            _context7.next = 14;
             return updateCache({
               client: client,
               konnector: konnector,
@@ -712,7 +700,7 @@ export var createTemporaryToken = /*#__PURE__*/function () {
             });
 
           case 14:
-            tokenCache = _context8.sent;
+            tokenCache = _context7.sent;
 
           case 15:
             assert(cozyBankIds.length, 'createTemporaryToken: Could not determine cozyBankIds from account or konnector');
@@ -721,18 +709,18 @@ export var createTemporaryToken = /*#__PURE__*/function () {
             tokenCache.biBankIds = _toConsumableArray(new Set(cozyBankIds.map(function (id) {
               return biMapping[id];
             })));
-            return _context8.abrupt("return", tokenCache);
+            return _context7.abrupt("return", tokenCache);
 
           case 20:
           case "end":
-            return _context8.stop();
+            return _context7.stop();
         }
       }
-    }, _callee8);
+    }, _callee7);
   }));
 
-  return function createTemporaryToken(_x10) {
-    return _ref20.apply(this, arguments);
+  return function createTemporaryToken(_x9) {
+    return _ref18.apply(this, arguments);
   };
 }();
 export var konnectorPolicy = {

package/dist/services/biWebView.spec.js

@@ -548,10 +548,7 @@ describe('isCacheExpired', function () {
     var biUser = {
       userId: 666
     };
-    expect(isCacheExpired({
-      tokenCache: tokenCache,
-      biUser: biUser
-    })).toBe(false);
+    expect(isCacheExpired(tokenCache, biUser)).toBe(false);
   });
   it('should be marked as expired when userId did not change and cache is old', function () {
     var tokenCache = {
@@ -561,10 +558,7 @@ describe('isCacheExpired', function () {
     var biUser = {
       userId: 666
     };
-    expect(isCacheExpired({
-      tokenCache: tokenCache,
-      biUser: biUser
-    })).toBe(true);
+    expect(isCacheExpired(tokenCache, biUser)).toBe(true);
   });
   it('should be marked as expired when userId did change and cache is old', function () {
     var tokenCache = {
@@ -574,10 +568,7 @@ describe('isCacheExpired', function () {
     var biUser = {
       userId: 667
     };
-    expect(isCacheExpired({
-      tokenCache: tokenCache,
-      biUser: biUser
-    })).toBe(true);
+    expect(isCacheExpired(tokenCache, biUser)).toBe(true);
   });
   it('should be marked as expired when userId did change and cache is not old', function () {
     var tokenCache = {
@@ -587,10 +578,7 @@ describe('isCacheExpired', function () {
     var biUser = {
       userId: 667
     };
-    expect(isCacheExpired({
-      tokenCache: tokenCache,
-      biUser: biUser
-    })).toBe(true);
+    expect(isCacheExpired(tokenCache, biUser)).toBe(true);
   });
   it('should be marked as expired when cache has no user id', function () {
     var tokenCache = {
@@ -599,10 +587,7 @@ describe('isCacheExpired', function () {
     var biUser = {
       userId: 666
     };
-    expect(isCacheExpired({
-      tokenCache: tokenCache,
-      biUser: biUser
-    })).toBe(true);
+    expect(isCacheExpired(tokenCache, biUser)).toBe(true);
   });
 });
 describe('fetchExtraOAuthUrlParams', function () {

package/dist/types.js

@@ -7,6 +7,12 @@
  * @property {Array<String>} bankIds - Cozy bank ids corresponding to the current connector
  * @property {Array<String>} biBankIds - BI bank ids corresponding to the bankIds translated by the connector
  * @property {Object} biMapping - Association table of any cozy bank id to corresponding bi bank id
+ * @property {String?} _rev
+ * @property {String} publicKey
+ * @property {String} clientId
+ * @property {String} mode
+ * @property {timestamp?} timestamp
+ * @property {String} userId - BI User id used to create the tmp token
  */
 
 /**
@@ -20,4 +26,21 @@
  * @property {boolean} active - Whether this connection is active and will be automatically synced.
  * @property {string|null} last_push - Date string: Last successfull push
  * @property {string|null} next_try - Date string: Date of next synchronization.
+ */
+
+/**
+ * @typedef {import("../../node_modules/cozy-client/types/types").CozyClientDocument} CozyClientDocument
+ */
+
+/**
+ * @typedef KonnectorManifest
+ * @property {String} slug
+ * @property {object} parameters
+ * @property {object} fields
+ * @property {object} aggregator
+ */
+
+/**
+ * @typedef {CozyClientDocument} IoCozyAccount
+ *
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-harvest-lib",
-  "version": "9.23.2",
+  "version": "9.23.3",
   "description": "Provides logic, modules and components for Cozy's harvest applications.",
   "main": "dist/index.js",
   "author": "Cozy",
@@ -90,5 +90,5 @@
     "react-router-dom": "^5.0.1"
   },
   "sideEffects": false,
-  "gitHead": "c5c6e0d609fafbc41a4b8cbfa8e1d4582544bbdd"
+  "gitHead": "86510d84bad90202b632c59b387c6a8aa58c0705"
 }

package/src/services/biWebView.js

@@ -1,3 +1,4 @@
+// @ts-check
 /**
  * Interface between Budget Insight and Cozy using BI's webview
  *
@@ -8,7 +9,9 @@ import { getBIConnection, getBIConnectionAccountsList } from './bi-http'
 import assert from '../assert'
 import logger from '../logger'
 import { Q } from 'cozy-client'
+// @ts-ignore (its a peerDep and I don't know how to configure ts for that)
 import flag from 'cozy-flags'
+
 import {
   setBIConnectionId,
   saveBIConfig,
@@ -22,6 +25,12 @@ import { waitForRealtimeEvent } from './jobUtils'
 import '../types'
 import { LOGIN_SUCCESS_EVENT } from '../models/flowEvents'
 
+/**
+ * @typedef {import("../models/ConnectionFlow").default} ConnectionFlow
+ * @typedef {object} CozyClient
+
+ */
+
 const TEMP_TOKEN_TIMOUT_S = 60
 export const ACCOUNTS_DOCTYPE = 'io.cozy.accounts'
 
@@ -30,13 +39,13 @@ export const isBiWebViewConnector = konnector =>
 
 /**
  * Runs multiple checks on the bi connection referenced in the given account
- *
- * @param {io.cozy.accounts} options.account The account content
- * @param {ConnectionFlow} options.flow
- * @param {io.cozy.konnectors} options.konnector connector manifest content
+ * @param {object} options
+ * @param {IoCozyAccount} options.account The account content
+ * @param {KonnectorManifest} options.konnector konnector manifest content
+ * @param {ConnectionFlow} options.flow The flow
  * @param {CozyClient} options.client CozyClient object
  *
- * @return {Integer} Connection Id
+ * @return {Promise<biConnection>} Connection Id
  */
 export const checkBIConnection = async ({
   account,
@@ -74,7 +83,6 @@ export const checkBIConnection = async ({
       const err = new KonnectorJobError(
         'ACCOUNT_WITH_SAME_IDENTIFIER_ALREADY_DEFINED'
       )
-      err.accountId = sameAccount._id
       throw err
     }
     return connection
@@ -100,12 +108,14 @@ export const fetchContractSynchronizationUrl = async ({
 /**
  * Handles webview connection
  *
- * @param {io.cozy.accounts} options.account The account content
- * @param {ConnectionFlow} options.flow
- * @param {io.cozy.konnectors} options.konnector connector manifest content
+ * @param {object} options
+ * @param {IoCozyAccount} options.account The account content
+ * @param {KonnectorManifest} options.konnector konnector manifest content
+ * @param {ConnectionFlow} options.flow The flow
  * @param {CozyClient} options.client CozyClient object
- *
- * @return {Integer} Connection Id
+ * @param {Boolean} options.reconnect If this is a reconnexion
+ * @param {Function} options.t Translation fonction
+ * @return {Promise<Number>} Connection Id
  */
 export const handleOAuthAccount = async ({
   account,
@@ -151,7 +161,7 @@ export const handleOAuthAccount = async ({
 /**
  * Return the bi aggregator parent relationship configuration for a given konnector
  *
- * @param {io.cozy.konnectors} konnector connector manifest content
+ * @param {KonnectorManifest} konnector connector manifest content
  *
  * @return {Object}
  */
@@ -176,9 +186,9 @@ const getBiAggregatorParentRelationship = konnector => {
  * Gets BI webview connection id which is returned in the account by the stack
  * via oauth callback url
  *
- * @param {io.cozy.accounts} The account content created by the stack
+ * @param {IoCozyAccount} account The account content created by the stack
  *
- * @return {Integer} Connection Id
+ * @return {Number|null} Connection Id or null if no connexion
  */
 const getWebviewBIConnectionId = account => {
   return Number(account?.oauth?.query?.connection_id?.[0] || null)
@@ -186,13 +196,13 @@ const getWebviewBIConnectionId = account => {
 
 /**
  * Hook from ConnectionFlow after account creation
- *
- * @param {io.cozy.accounts} options.account - created account
- * @param {io.cozy.konnectors} options.konnector  - manifest of the konnector for which the account is created
+ * @param {object} options
+ * @param {IoCozyAccount} options.account - created account
+ * @param {KonnectorManifest} options.konnector konnector manifest content
  * @param {ConnectionFlow} options.flow - current ConnectionFlow instance
  * @param {CozyClient} options.client - current CozyClient instance
  *
- * @returns {Promise<io.cozy.accounts>}
+ * @returns {Promise<IoCozyAccount>}
  */
 export const onBIAccountCreation = async ({
   account: fullAccount,
@@ -227,17 +237,13 @@ export const onBIAccountCreation = async ({
 
 /**
  * Create OAuth extra parameters specific to reconnect webview
- *
- * @param {Array<Number>} options.biBankIds - connector bank ids (for webview connectors)
+ * @param {object} options
+ * @param {Array<String>} options.biBankIds - connector bank ids (for webview connectors)
  * @param {String} options.token - BI temporary token
  * @param {Number} options.connId - BI bi connection id
  * @return {Object}
  */
-const getReconnectExtraOAuthUrlParams = async ({
-  biBankIds,
-  token,
-  connId
-}) => {
+const getReconnectExtraOAuthUrlParams = ({ biBankIds, token, connId }) => {
   return {
     id_connector: biBankIds,
     code: token,
@@ -247,10 +253,10 @@ const getReconnectExtraOAuthUrlParams = async ({
 
 /**
  * Create OAuth extra parameters
- *
+ * @param {object} options
  * @param {CozyClient} options.client - CozyClient instance
- * @param {io.cozy.konnectors} options.konnector connector manifest content
- * @param {io.cozy.accounts} options.account The account content
+ * @param {KonnectorManifest} options.konnector konnector manifest content
+ * @param {IoCozyAccount} options.account The account content
  * @return {Promise<Object>}
  */
 export const fetchExtraOAuthUrlParams = async ({
@@ -284,9 +290,9 @@ export const fetchExtraOAuthUrlParams = async ({
 
 /**
  * Finds the current bankIid in a given konnector or account
- *
- * @param {io.cozy.accounts} options.account The account content
- * @param {io.cozy.konnectors} options.konnector connector manifest content
+ * @param {object} options
+ * @param {IoCozyAccount} options.account The account content
+ * @param {KonnectorManifest} options.konnector konnector manifest content
  * @return {Array<String>} - list of bank ids
  */
 export const getCozyBankIds = ({ konnector, account }) => {
@@ -305,10 +311,10 @@ export const getCozyBankIds = ({ konnector, account }) => {
 
 /**
  * Update imported state of contracts in the given account, according to current state of the accounts on the BI side.
- *
+ * @param {object} options
  * @param {CozyClient} options.client - CozyClient instance
- * @param {io.cozy.accounts} options.account The account content
- * @param {io.cozy.konnectors} options.konnector connector manifest content
+ * @param {IoCozyAccount} options.account The account content
+ * @param {KonnectorManifest} options.konnector konnector manifest content
  */
 export const refreshContracts = async ({ client, konnector, account }) => {
   const biConfig = await createTemporaryToken({
@@ -347,7 +353,7 @@ function convertBIDateToStandardDate(biDate) {
  * Get the BI temporary token cache from Cozy doctype
  *
  * @param {CozyClient} options.client CozyClient instance
- * @return {createTemporaryTokenResponse}
+ * @return {Promise<createTemporaryTokenResponse>}
  */
 async function getBiTemporaryTokenFromCache({ client }) {
   const queryResult = await client.query(
@@ -358,11 +364,11 @@ async function getBiTemporaryTokenFromCache({ client }) {
 
 /**
  * Check if BI temporary token cache is expired or not
- *
- * @param {createTemporaryTokenResponse} options.tokenCache
+ * @param {createTemporaryTokenResponse} tokenCache
+ * @param {Object} biUser the bi user
  * @return {Boolean}
  */
-export function isCacheExpired({ tokenCache, biUser }) {
+export function isCacheExpired(tokenCache, biUser) {
   const cacheAge = Date.now() - Number(tokenCache?.timestamp)
   logger.debug('tokenCache age', cacheAge / 1000 / 60, 'minutes')
   const MAX_TOKEN_CACHE_AGE = 29 * 60 * 1000
@@ -381,12 +387,12 @@ export function isCacheExpired({ tokenCache, biUser }) {
 
 /**
  * Update the BI temporary token cache from BI itself
- *
+ * @param {object} options
  * @param {CozyClient} options.client CozyClient instance
- * @param {io.cozy.konnectors} options.konnector
- * @param {Array<Number>} options.cozyBankIds List of cozy bank identifiers
+ * @param {KonnectorManifest} options.konnector konnector manifest content
+ * @param {Array<String>} options.cozyBankIds List of cozy bank identifiers
  * @param {createTemporaryTokenResponse} options.tokenCache Previous version of BI temporary token cache
- * @return {createTemporaryTokenResponse}
+ * @return {Promise<createTemporaryTokenResponse>}
  */
 async function updateCache({ client, konnector, tokenCache, cozyBankIds }) {
   const jobResponse = await client.stackClient.jobs.create(
@@ -417,12 +423,12 @@ async function updateCache({ client, konnector, tokenCache, cozyBankIds }) {
 
 /**
  * Gets a temporary token corresponding to the current BI user
- *
+ * @param {object} options
  * @param {CozyClient} options.client - CozyClient instance
- * @param {io.cozy.konnectors} options.konnector connector manifest content
- * @param {io.cozy.accounts} options.account The account content
+ * @param {KonnectorManifest} options.konnector konnector manifest content
+ * @param {IoCozyAccount} options.account The account content
  *
- * @returns {createTemporaryTokenResponse}
+ * @returns {Promise<createTemporaryTokenResponse>}
  */
 export const createTemporaryToken = async ({ client, konnector, account }) => {
   assert(
@@ -437,7 +443,7 @@ export const createTemporaryToken = async ({ client, konnector, account }) => {
     Q('io.cozy.accounts').getById('bi-aggregator-user')
   )
 
-  if (isCacheExpired({ tokenCache, biUser })) {
+  if (isCacheExpired(tokenCache, biUser)) {
     logger.debug('temporaryToken cache is expired. Updating')
     tokenCache = await updateCache({
       client,

package/src/services/biWebView.spec.js

@@ -335,27 +335,27 @@ describe('isCacheExpired', () => {
   it('should not be marked as expired when userId did not change and cache is not old', () => {
     const tokenCache = { timestamp: Date.now(), userId: 666 }
     const biUser = { userId: 666 }
-    expect(isCacheExpired({ tokenCache, biUser })).toBe(false)
+    expect(isCacheExpired(tokenCache, biUser)).toBe(false)
   })
   it('should be marked as expired when userId did not change and cache is old', () => {
     const tokenCache = { timestamp: 0, userId: 666 }
     const biUser = { userId: 666 }
-    expect(isCacheExpired({ tokenCache, biUser })).toBe(true)
+    expect(isCacheExpired(tokenCache, biUser)).toBe(true)
   })
   it('should be marked as expired when userId did change and cache is old', () => {
     const tokenCache = { timestamp: 0, userId: 666 }
     const biUser = { userId: 667 }
-    expect(isCacheExpired({ tokenCache, biUser })).toBe(true)
+    expect(isCacheExpired(tokenCache, biUser)).toBe(true)
   })
   it('should be marked as expired when userId did change and cache is not old', () => {
     const tokenCache = { timestamp: Date.now(), userId: 666 }
     const biUser = { userId: 667 }
-    expect(isCacheExpired({ tokenCache, biUser })).toBe(true)
+    expect(isCacheExpired(tokenCache, biUser)).toBe(true)
   })
   it('should be marked as expired when cache has no user id', () => {
     const tokenCache = { timestamp: Date.now() }
     const biUser = { userId: 666 }
-    expect(isCacheExpired({ tokenCache, biUser })).toBe(true)
+    expect(isCacheExpired(tokenCache, biUser)).toBe(true)
   })
 })
 

package/src/types.js

@@ -7,6 +7,12 @@
  * @property {Array<String>} bankIds - Cozy bank ids corresponding to the current connector
  * @property {Array<String>} biBankIds - BI bank ids corresponding to the bankIds translated by the connector
  * @property {Object} biMapping - Association table of any cozy bank id to corresponding bi bank id
+ * @property {String?} _rev
+ * @property {String} publicKey
+ * @property {String} clientId
+ * @property {String} mode
+ * @property {timestamp?} timestamp
+ * @property {String} userId - BI User id used to create the tmp token
  */
 
 /**
@@ -21,3 +27,19 @@
  * @property {string|null} last_push - Date string: Last successfull push
  * @property {string|null} next_try - Date string: Date of next synchronization.
  */
+
+/**
+ * @typedef {import("../../node_modules/cozy-client/types/types").CozyClientDocument} CozyClientDocument
+ */
+/**
+ * @typedef KonnectorManifest
+ * @property {String} slug
+ * @property {object} parameters
+ * @property {object} fields
+ * @property {object} aggregator
+ */
+
+/**
+ * @typedef {CozyClientDocument} IoCozyAccount
+ *
+ */