cozy-harvest-lib 9.4.0 → 9.6.0

package/CHANGELOG.md

@@ -3,6 +3,36 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [9.6.0](https://github.com/cozy/cozy-libs/compare/cozy-harvest-lib@9.5.1...cozy-harvest-lib@9.6.0) (2022-06-01)
+
+
+### Features
+
+* Trigger success sooner for BI webviews ([b0dbd39](https://github.com/cozy/cozy-libs/commit/b0dbd396552cfa3cc7ae2972e500c449331ba83b))
+
+
+
+
+
+## [9.5.1](https://github.com/cozy/cozy-libs/compare/cozy-harvest-lib@9.5.0...cozy-harvest-lib@9.5.1) (2022-05-25)
+
+**Note:** Version bump only for package cozy-harvest-lib
+
+
+
+
+
+# [9.5.0](https://github.com/cozy/cozy-libs/compare/cozy-harvest-lib@9.4.0...cozy-harvest-lib@9.5.0) (2022-05-23)
+
+
+### Features
+
+* Handle banks with mulitple bank ids ([a944201](https://github.com/cozy/cozy-libs/commit/a944201ca5752766a49689f42531c84f03798002))
+
+
+
+
+
 # [9.4.0](https://github.com/cozy/cozy-libs/compare/cozy-harvest-lib@9.3.0...cozy-harvest-lib@9.4.0) (2022-05-18)
 
 

package/dist/services/biWebView.js

@@ -18,8 +18,12 @@ import { getBIConnection } from './bi-http';
 import assert from '../assert';
 import logger from '../logger';
 import flag from 'cozy-flags';
-import { fetchExtraOAuthUrlParams, createTemporaryToken, setBIConnectionId, saveBIConfig, findAccountWithBiConnection, convertBIErrortoKonnectorJobError, isBudgetInsightConnector } from './budget-insight';
+import { setBIConnectionId, saveBIConfig, findAccountWithBiConnection, convertBIErrortoKonnectorJobError, isBudgetInsightConnector } from './budget-insight';
 import { KonnectorJobError } from '../helpers/konnectors';
+import { waitForRealtimeEvent } from './jobUtils';
+import '../types';
+import { LOGIN_SUCCESS_EVENT } from '../models/flowEvents';
+var TEMP_TOKEN_TIMOUT_S = 60;
 export var isBiWebViewConnector = function isBiWebViewConnector(konnector) {
   return flag('harvest.bi.webview') && isBudgetInsightConnector(konnector);
 };
@@ -116,19 +120,19 @@ export var checkBIConnection = /*#__PURE__*/function () {
 
 export var handleOAuthAccount = /*#__PURE__*/function () {
   var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(_ref3) {
-    var account, flow, konnector, client, t, cozyBankId, biWebviewAccount, connectionId;
+    var account, flow, konnector, client, t, cozyBankIds, biWebviewAccount, connectionId;
     return _regeneratorRuntime.wrap(function _callee2$(_context2) {
       while (1) {
         switch (_context2.prev = _context2.next) {
           case 0:
             account = _ref3.account, flow = _ref3.flow, konnector = _ref3.konnector, client = _ref3.client, t = _ref3.t;
-            cozyBankId = getCozyBankId({
+            cozyBankIds = getCozyBankIds({
               konnector: konnector,
               account: account
             });
-            biWebviewAccount = _objectSpread(_objectSpread({}, account), cozyBankId ? {
+            biWebviewAccount = _objectSpread(_objectSpread({}, account), cozyBankIds ? {
               auth: {
-                bankId: cozyBankId
+                bankIds: cozyBankIds
               }
             } : {});
             connectionId = getWebviewBIConnectionId(biWebviewAccount);
@@ -196,7 +200,7 @@ var getWebviewBIConnectionId = function getWebviewBIConnectionId(account) {
 
 export var onBIAccountCreation = /*#__PURE__*/function () {
   var _ref6 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(_ref5) {
-    var fullAccount, client, flow, konnector, account, biConnection;
+    var fullAccount, client, flow, konnector, account, biConnection, updatedAccount;
     return _regeneratorRuntime.wrap(function _callee3$(_context3) {
       while (1) {
         switch (_context3.prev = _context3.next) {
@@ -226,9 +230,11 @@ export var onBIAccountCreation = /*#__PURE__*/function () {
             return flow.saveAccount(setBIConnectionId(account, biConnection.id));
 
           case 10:
-            return _context3.abrupt("return", _context3.sent);
+            updatedAccount = _context3.sent;
+            flow.triggerEvent(LOGIN_SUCCESS_EVENT);
+            return _context3.abrupt("return", updatedAccount);
 
-          case 11:
+          case 13:
           case "end":
             return _context3.stop();
         }
@@ -240,26 +246,125 @@ export var onBIAccountCreation = /*#__PURE__*/function () {
     return _ref6.apply(this, arguments);
   };
 }();
+export var fetchExtraOAuthUrlParams = /*#__PURE__*/function () {
+  var _ref8 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4(_ref7) {
+    var client, konnector, account, _yield$createTemporar, token, biBankId, biBankIds;
+
+    return _regeneratorRuntime.wrap(function _callee4$(_context4) {
+      while (1) {
+        switch (_context4.prev = _context4.next) {
+          case 0:
+            client = _ref7.client, konnector = _ref7.konnector, account = _ref7.account;
+            _context4.next = 3;
+            return createTemporaryToken({
+              client: client,
+              konnector: konnector,
+              account: account
+            });
+
+          case 3:
+            _yield$createTemporar = _context4.sent;
+            token = _yield$createTemporar.code;
+            biBankId = _yield$createTemporar.biBankId;
+            biBankIds = _yield$createTemporar.biBankIds;
+            return _context4.abrupt("return", {
+              id_connector: biBankId || biBankIds,
+              token: token
+            });
+
+          case 8:
+          case "end":
+            return _context4.stop();
+        }
+      }
+    }, _callee4);
+  }));
+
+  return function fetchExtraOAuthUrlParams(_x4) {
+    return _ref8.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
+ * @return {Array<String>} - list of bank ids
  */
 
-export var getCozyBankId = function getCozyBankId(_ref7) {
-  var _konnector$parameters, _account$auth;
+export var getCozyBankIds = function getCozyBankIds(_ref9) {
+  var _konnector$parameters, _account$auth, _konnector$fields, _konnector$fields$ban;
 
-  var konnector = _ref7.konnector,
-      account = _ref7.account;
+  var konnector = _ref9.konnector,
+      account = _ref9.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) {
+  if (cozyBankId) {
+    return [cozyBankId];
+  }
+
+  var cozyBankIds = konnector === null || konnector === void 0 ? void 0 : (_konnector$fields = konnector.fields) === null || _konnector$fields === void 0 ? void 0 : (_konnector$fields$ban = _konnector$fields.bankId) === null || _konnector$fields$ban === void 0 ? void 0 : _konnector$fields$ban.options.map(function (opt) {
+    return opt === null || opt === void 0 ? void 0 : opt.value;
+  });
+
+  if (!(cozyBankIds !== null && cozyBankIds !== void 0 && cozyBankIds.length)) {
     logger.error('Could not find any bank id');
   }
 
-  return cozyBankId;
+  return cozyBankIds;
 };
+/**
+ * Gets a temporary token corresponding to the current BI user
+ *
+ * @param {CozyClient} options.client - CozyClient instance
+ * @param {io.cozy.konnectors} options.konnector connector manifest content
+ * @param {io.cozy.accounts} options.account The account content
+ *
+ * @returns {createTemporaryTokenResponse}
+ */
+
+export var createTemporaryToken = /*#__PURE__*/function () {
+  var _ref11 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee5(_ref10) {
+    var client, konnector, account, cozyBankIds, jobResponse, event;
+    return _regeneratorRuntime.wrap(function _callee5$(_context5) {
+      while (1) {
+        switch (_context5.prev = _context5.next) {
+          case 0:
+            client = _ref10.client, konnector = _ref10.konnector, account = _ref10.account;
+            assert(konnector.slug, 'createTemporaryToken: konnector passed in options has no slug');
+            cozyBankIds = getCozyBankIds({
+              konnector: konnector,
+              account: account
+            });
+            assert(cozyBankIds.length, 'createTemporaryToken: Could not determine cozyBankId from account or konnector');
+            _context5.next = 6;
+            return client.stackClient.jobs.create('konnector', {
+              mode: 'getTemporaryToken',
+              konnector: konnector.slug,
+              bankIds: cozyBankIds
+            }, {}, true);
+
+          case 6:
+            jobResponse = _context5.sent;
+            _context5.next = 9;
+            return waitForRealtimeEvent(client, jobResponse.data.attributes, 'result', TEMP_TOKEN_TIMOUT_S * 1000);
+
+          case 9:
+            event = _context5.sent;
+            return _context5.abrupt("return", event.data.result);
+
+          case 11:
+          case "end":
+            return _context5.stop();
+        }
+      }
+    }, _callee5);
+  }));
+
+  return function createTemporaryToken(_x5) {
+    return _ref11.apply(this, arguments);
+  };
+}();
 export var konnectorPolicy = {
   isBIWebView: true,
   name: 'budget-insight-webview',

package/dist/services/biWebView.spec.js

@@ -113,7 +113,7 @@ describe('handleOAuthAccount', function () {
               t: t,
               account: _objectSpread(_objectSpread(_objectSpread({}, account), {
                 auth: {
-                  bankId: TEST_BANK_COZY_ID
+                  bankIds: [TEST_BANK_COZY_ID]
                 }
               }), {
                 data: {

package/dist/services/budget-insight.js

@@ -34,6 +34,7 @@ import { mkConnAuth, biErrorMap } from 'cozy-bi-auth';
 import { KonnectorJobError } from '../helpers/konnectors';
 import { LOGIN_SUCCESS_EVENT } from '../models/flowEvents';
 import logger from '../logger';
+import '../types';
 var DECOUPLED_ERROR = 'decoupled';
 var ADDITIONAL_INFORMATION_NEEDED_ERROR = 'additionalInformationNeeded';
 var TEMP_TOKEN_TIMOUT_S = 60;
@@ -401,19 +402,6 @@ export var resumeBIConnection = function resumeBIConnection(flow) {
     resume: 'true'
   });
 };
-/**
- * @typedef biConnection
- * @property {number} id
- * @property {number} id_user
- * @property {number} id_connector
- * @property {string|null} state  - ( wrongpass | additionalInformationNeeded | websiteUnavailable | actionNeeded | SCARequired | decoupled | passwordExpired | webauthRequired | rateLimiting | bug). Null indicates a success
- * @property {string|null} last_update - Date string: Last successful update.
- * @property {string|null} created - Date string: Creation date
- * @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.
- */
-
 /**
  * Checks for any number 2FA and/or decoupled requests
  *

package/dist/types.js

@@ -0,0 +1,22 @@
+/**
+ * @typedef createTemporaryTokenResponse
+ * @property {String} code - the temporary token
+ * @property {String} url - BI environment url
+ * @property {String} bankId - Cozy bank id corresponding to the current connector (deprecated once bi webviews are in production)
+ * @property {String} biBankId - BI bank id corresponding to the bankId translated by the connector (deprecated once bi webviews are in production)
+ * @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
+ */
+
+/**
+ * @typedef biConnection
+ * @property {number} id
+ * @property {number} id_user
+ * @property {number} id_connector
+ * @property {string|null} state  - ( wrongpass | additionalInformationNeeded | websiteUnavailable | actionNeeded | SCARequired | decoupled | passwordExpired | webauthRequired | rateLimiting | bug). Null indicates a success
+ * @property {string|null} last_update - Date string: Last successful update.
+ * @property {string|null} created - Date string: Creation date
+ * @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.
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-harvest-lib",
-  "version": "9.4.0",
+  "version": "9.6.0",
   "description": "Provides logic, modules and components for Cozy's harvest applications.",
   "main": "dist/index.js",
   "author": "Cozy",
@@ -44,7 +44,7 @@
     "@babel/cli": "7.16.8",
     "@babel/core": "7.16.12",
     "@babel/register": "7.16.9",
-    "@cozy/cli-tree": "^0.5.0",
+    "@cozy/cli-tree": "^0.6.0",
     "@material-ui/core": "4.11.3",
     "@material-ui/lab": "4.0.0-alpha.60",
     "@testing-library/jest-dom": "5.16.4",
@@ -87,5 +87,5 @@
     "react-router-dom": "^5.0.1"
   },
   "sideEffects": false,
-  "gitHead": "9ab356f1f7eea371ff0d364ec1eb740aa8d4fd47"
+  "gitHead": "24403169dfb9d4df1a754248b55f663d1161d166"
 }

package/src/services/biWebView.js

@@ -9,8 +9,6 @@ import assert from '../assert'
 import logger from '../logger'
 import flag from 'cozy-flags'
 import {
-  fetchExtraOAuthUrlParams,
-  createTemporaryToken,
   setBIConnectionId,
   saveBIConfig,
   findAccountWithBiConnection,
@@ -18,6 +16,11 @@ import {
   isBudgetInsightConnector
 } from './budget-insight'
 import { KonnectorJobError } from '../helpers/konnectors'
+import { waitForRealtimeEvent } from './jobUtils'
+import '../types'
+import { LOGIN_SUCCESS_EVENT } from '../models/flowEvents'
+
+const TEMP_TOKEN_TIMOUT_S = 60
 
 export const isBiWebViewConnector = konnector =>
   flag('harvest.bi.webview') && isBudgetInsightConnector(konnector)
@@ -94,10 +97,10 @@ export const handleOAuthAccount = async ({
   client,
   t
 }) => {
-  const cozyBankId = getCozyBankId({ konnector, account })
+  const cozyBankIds = getCozyBankIds({ konnector, account })
   let biWebviewAccount = {
     ...account,
-    ...(cozyBankId ? { auth: { bankId: cozyBankId } } : {})
+    ...(cozyBankIds ? { auth: { bankIds: cozyBankIds } } : {})
   }
 
   const connectionId = getWebviewBIConnectionId(biWebviewAccount)
@@ -164,7 +167,31 @@ export const onBIAccountCreation = async ({
     biConnection
   })
 
-  return await flow.saveAccount(setBIConnectionId(account, biConnection.id))
+  const updatedAccount = await flow.saveAccount(
+    setBIConnectionId(account, biConnection.id)
+  )
+
+  flow.triggerEvent(LOGIN_SUCCESS_EVENT)
+
+  return updatedAccount
+}
+
+export const fetchExtraOAuthUrlParams = async ({
+  client,
+  konnector,
+  account
+}) => {
+  const {
+    code: token,
+    biBankId,
+    biBankIds
+  } = await createTemporaryToken({
+    client,
+    konnector,
+    account
+  })
+
+  return { id_connector: biBankId || biBankIds, token }
 }
 
 /**
@@ -172,13 +199,58 @@ export const onBIAccountCreation = async ({
  *
  * @param {io.cozy.accounts} options.account The account content
  * @param {io.cozy.konnectors} options.konnector connector manifest content
+ * @return {Array<String>} - list of bank ids
  */
-export const getCozyBankId = ({ konnector, account }) => {
+export const getCozyBankIds = ({ konnector, account }) => {
   const cozyBankId = konnector?.parameters?.bankId || account?.auth?.bankId
-  if (!cozyBankId) {
+
+  if (cozyBankId) {
+    return [cozyBankId]
+  }
+
+  const cozyBankIds = konnector?.fields?.bankId?.options.map(opt => opt?.value)
+  if (!cozyBankIds?.length) {
     logger.error('Could not find any bank id')
   }
-  return cozyBankId
+  return cozyBankIds
+}
+
+/**
+ * Gets a temporary token corresponding to the current BI user
+ *
+ * @param {CozyClient} options.client - CozyClient instance
+ * @param {io.cozy.konnectors} options.konnector connector manifest content
+ * @param {io.cozy.accounts} options.account The account content
+ *
+ * @returns {createTemporaryTokenResponse}
+ */
+export const createTemporaryToken = async ({ client, konnector, account }) => {
+  assert(
+    konnector.slug,
+    'createTemporaryToken: konnector passed in options has no slug'
+  )
+  const cozyBankIds = getCozyBankIds({ konnector, account })
+  assert(
+    cozyBankIds.length,
+    'createTemporaryToken: Could not determine cozyBankId from account or konnector'
+  )
+  const jobResponse = await client.stackClient.jobs.create(
+    'konnector',
+    {
+      mode: 'getTemporaryToken',
+      konnector: konnector.slug,
+      bankIds: cozyBankIds
+    },
+    {},
+    true
+  )
+  const event = await waitForRealtimeEvent(
+    client,
+    jobResponse.data.attributes,
+    'result',
+    TEMP_TOKEN_TIMOUT_S * 1000
+  )
+  return event.data.result
 }
 
 export const konnectorPolicy = {

package/src/services/biWebView.spec.js

@@ -69,7 +69,7 @@ describe('handleOAuthAccount', () => {
       t,
       account: {
         ...account,
-        ...{ auth: { bankId: TEST_BANK_COZY_ID } },
+        ...{ auth: { bankIds: [TEST_BANK_COZY_ID] } },
         ...{ data: { auth: { bi: { connId: 12 } } } }
       }
     })

package/src/services/budget-insight.js

@@ -27,6 +27,7 @@ import { mkConnAuth, biErrorMap } from 'cozy-bi-auth'
 import { KonnectorJobError } from '../helpers/konnectors'
 import { LOGIN_SUCCESS_EVENT } from '../models/flowEvents'
 import logger from '../logger'
+import '../types'
 
 const DECOUPLED_ERROR = 'decoupled'
 const ADDITIONAL_INFORMATION_NEEDED_ERROR = 'additionalInformationNeeded'
@@ -292,19 +293,6 @@ export const resumeBIConnection = flow => {
   return updateBIConnectionFromFlow(flow, { resume: 'true' })
 }
 
-/**
- * @typedef biConnection
- * @property {number} id
- * @property {number} id_user
- * @property {number} id_connector
- * @property {string|null} state  - ( wrongpass | additionalInformationNeeded | websiteUnavailable | actionNeeded | SCARequired | decoupled | passwordExpired | webauthRequired | rateLimiting | bug). Null indicates a success
- * @property {string|null} last_update - Date string: Last successful update.
- * @property {string|null} created - Date string: Creation date
- * @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.
- */
-
 /**
  * Checks for any number 2FA and/or decoupled requests
  *

package/src/types.js

@@ -0,0 +1,22 @@
+/**
+ * @typedef createTemporaryTokenResponse
+ * @property {String} code - the temporary token
+ * @property {String} url - BI environment url
+ * @property {String} bankId - Cozy bank id corresponding to the current connector (deprecated once bi webviews are in production)
+ * @property {String} biBankId - BI bank id corresponding to the bankId translated by the connector (deprecated once bi webviews are in production)
+ * @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
+ */
+
+/**
+ * @typedef biConnection
+ * @property {number} id
+ * @property {number} id_user
+ * @property {number} id_connector
+ * @property {string|null} state  - ( wrongpass | additionalInformationNeeded | websiteUnavailable | actionNeeded | SCARequired | decoupled | passwordExpired | webauthRequired | rateLimiting | bug). Null indicates a success
+ * @property {string|null} last_update - Date string: Last successful update.
+ * @property {string|null} created - Date string: Creation date
+ * @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.
+ */