cozy-client 27.20.0 → 27.22.1

package/dist/CozyClient.js

@@ -1942,7 +1942,7 @@ var CozyClient = /*#__PURE__*/function () {
     /**
      * Performs a complete OAuth flow, including updating the internal token at the end.
      *
-     * @param   {Function} openURLCallback Receives the URL to present to the user as a parameter, and should return a promise that resolves with the URL the user was redirected to after accepting the permissions.
+     * @param   {OpenURLCallback} openURLCallback Receives the URL to present to the user as a parameter, and should return a promise that resolves with the URL the user was redirected to after accepting the permissions.
      * @returns {Promise<object>} Contains the fetched token and the client information. These should be stored and used to restore the client.
      */
 
@@ -1960,18 +1960,15 @@ var CozyClient = /*#__PURE__*/function () {
                 return stackClient.register();
 
               case 3:
-                if (!stackClient.oauthOptions.shouldRequireFlagshipPermissions) {
-                  _context14.next = 6;
-                  break;
-                }
+                _context14.next = 5;
+                return this.certifyFlagship();
 
-                _context14.next = 6;
-                return (0, _flagshipCertification.certifyFlagship)(stackClient.oauthOptions.certificationConfig, this);
+              case 5:
+                return _context14.abrupt("return", this.authorize({
+                  openURLCallback: openURLCallback
+                }));
 
               case 6:
-                return _context14.abrupt("return", this.authorize(openURLCallback));
-
-              case 7:
               case "end":
                 return _context14.stop();
             }
@@ -1985,61 +1982,135 @@ var CozyClient = /*#__PURE__*/function () {
 
       return startOAuthFlow;
     }()
+    /**
+     * Perform the Flagship certification process for verifying that the current running app is a genuine Cozy application
+     *
+     * This mechanism is described in https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/flagship-certification/README.md
+     */
+
   }, {
-    key: "authorize",
+    key: "certifyFlagship",
     value: function () {
-      var _authorize = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee15(openURLCallback) {
-        var stackClient, stateCode, url, redirectedURL, code, token, _stackClient;
-
+      var _certifyFlagship2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee15() {
+        var stackClient;
         return _regenerator.default.wrap(function _callee15$(_context15) {
           while (1) {
             switch (_context15.prev = _context15.next) {
               case 0:
-                _context15.prev = 0;
+                stackClient = this.getStackClient();
+
+                if (!stackClient.oauthOptions.shouldRequireFlagshipPermissions) {
+                  _context15.next = 4;
+                  break;
+                }
+
+                _context15.next = 4;
+                return (0, _flagshipCertification.certifyFlagship)(stackClient.oauthOptions.certificationConfig, this);
+
+              case 4:
+              case "end":
+                return _context15.stop();
+            }
+          }
+        }, _callee15, this);
+      }));
+
+      function certifyFlagship() {
+        return _certifyFlagship2.apply(this, arguments);
+      }
+
+      return certifyFlagship;
+    }()
+    /**
+     * Creates an OAuth token with needed permissions for the current client.
+     * The authorization page URL generation can be overriding by passing a function pointer as `openURLCallback` parameter
+     * It is possible to skip the session creation process (when using an in-app browser) by passing a sessionCode (see https://docs.cozy.io/en/cozy-stack/auth/#post-authsession_code)
+     *
+     * @param {object} [options] - Authorization options
+     * @param {OpenURLCallback} [options.openURLCallback] - Receives the URL to present to the user as a parameter, and should return a promise that resolves with the URL the user was redirected to after accepting the permissions.
+     * @param {SessionCode} [options.sessionCode] - session code than can be added to the authorization URL to automatically create the session.
+     * @param {PKCECodes} [options.pkceCodes] - code verifier and a code challenge that should be used in the PKCE verification process.
+     * @returns {Promise<object>} Contains the fetched token and the client information. These should be stored and used to restore the client.
+     */
+
+  }, {
+    key: "authorize",
+    value: function () {
+      var _authorize = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee16() {
+        var _ref6,
+            _ref6$openURLCallback,
+            openURLCallback,
+            _ref6$sessionCode,
+            sessionCode,
+            _ref6$pkceCodes,
+            pkceCodes,
+            codeVerifier,
+            codeChallenge,
+            stackClient,
+            stateCode,
+            url,
+            redirectedURL,
+            code,
+            token,
+            _stackClient,
+            _args16 = arguments;
+
+        return _regenerator.default.wrap(function _callee16$(_context16) {
+          while (1) {
+            switch (_context16.prev = _context16.next) {
+              case 0:
+                _ref6 = _args16.length > 0 && _args16[0] !== undefined ? _args16[0] : {}, _ref6$openURLCallback = _ref6.openURLCallback, openURLCallback = _ref6$openURLCallback === void 0 ? _mobile.authFunction : _ref6$openURLCallback, _ref6$sessionCode = _ref6.sessionCode, sessionCode = _ref6$sessionCode === void 0 ? undefined : _ref6$sessionCode, _ref6$pkceCodes = _ref6.pkceCodes, pkceCodes = _ref6$pkceCodes === void 0 ? {} : _ref6$pkceCodes;
+                _context16.prev = 1;
+                codeVerifier = pkceCodes.codeVerifier, codeChallenge = pkceCodes.codeChallenge;
                 stackClient = this.getStackClient();
                 stateCode = stackClient.generateStateCode();
-                url = stackClient.getAuthCodeURL(stateCode);
-                _context15.next = 6;
+                url = stackClient.getAuthCodeURL({
+                  stateCode: stateCode,
+                  scopes: undefined,
+                  sessionCode: sessionCode,
+                  codeChallenge: codeChallenge
+                });
+                _context16.next = 8;
                 return openURLCallback(url);
 
-              case 6:
-                redirectedURL = _context15.sent;
+              case 8:
+                redirectedURL = _context16.sent;
                 code = stackClient.getAccessCodeFromURL(redirectedURL, stateCode);
-                _context15.next = 10;
-                return stackClient.fetchAccessToken(code);
+                _context16.next = 12;
+                return stackClient.fetchAccessToken(code, undefined, undefined, codeVerifier);
 
-              case 10:
-                token = _context15.sent;
+              case 12:
+                token = _context16.sent;
                 stackClient.setToken(token);
-                return _context15.abrupt("return", {
+                return _context16.abrupt("return", {
                   token: token,
                   infos: stackClient.oauthOptions,
                   client: stackClient.oauthOptions // for compat with Authentication comp reasons
 
                 });
 
-              case 15:
-                _context15.prev = 15;
-                _context15.t0 = _context15["catch"](0);
+              case 17:
+                _context16.prev = 17;
+                _context16.t0 = _context16["catch"](1);
 
                 /* if REGISTRATION_ABORT is emited, we have to unregister the client. */
-                if (_context15.t0.message === _const.REGISTRATION_ABORT) {
+                if (_context16.t0.message === _const.REGISTRATION_ABORT) {
                   _stackClient = this.getStackClient();
 
                   _stackClient.unregister();
                 }
 
-                throw _context15.t0;
+                throw _context16.t0;
 
-              case 19:
+              case 21:
               case "end":
-                return _context15.stop();
+                return _context16.stop();
             }
           }
-        }, _callee15, this, [[0, 15]]);
+        }, _callee16, this, [[1, 17]]);
       }));
 
-      function authorize(_x17) {
+      function authorize() {
         return _authorize.apply(this, arguments);
       }
 
@@ -2055,7 +2126,9 @@ var CozyClient = /*#__PURE__*/function () {
   }, {
     key: "renewAuthorization",
     value: function renewAuthorization() {
-      return this.authorize(_mobile.authFunction);
+      return this.authorize({
+        openURLCallback: _mobile.authFunction
+      });
     }
     /**
      * Sets the internal store of the client. Use this when you want to have cozy-client's
@@ -2083,9 +2156,9 @@ var CozyClient = /*#__PURE__*/function () {
   }, {
     key: "setStore",
     value: function setStore(store) {
-      var _ref6 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
-          _ref6$force = _ref6.force,
-          force = _ref6$force === void 0 ? false : _ref6$force;
+      var _ref7 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
+          _ref7$force = _ref7.force,
+          force = _ref7$force === void 0 ? false : _ref7$force;
 
       if (store === undefined) {
         throw new Error('Store is undefined');
@@ -2109,19 +2182,19 @@ var CozyClient = /*#__PURE__*/function () {
   }, {
     key: "checkForRevocation",
     value: function () {
-      var _checkForRevocation = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee16() {
-        return _regenerator.default.wrap(function _callee16$(_context16) {
+      var _checkForRevocation = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee17() {
+        return _regenerator.default.wrap(function _callee17$(_context17) {
           while (1) {
-            switch (_context16.prev = _context16.next) {
+            switch (_context17.prev = _context17.next) {
               case 0:
-                return _context16.abrupt("return", this.stackClient.checkForRevocation());
+                return _context17.abrupt("return", this.stackClient.checkForRevocation());
 
               case 1:
               case "end":
-                return _context16.stop();
+                return _context17.stop();
             }
           }
-        }, _callee16, this);
+        }, _callee17, this);
       }));
 
       function checkForRevocation() {
@@ -2279,10 +2352,10 @@ var CozyClient = /*#__PURE__*/function () {
       var _this10 = this;
 
       this.ensureStore();
-      Object.entries(data).forEach(function (_ref7) {
-        var _ref8 = (0, _slicedToArray2.default)(_ref7, 2),
-            doctype = _ref8[0],
-            data = _ref8[1];
+      Object.entries(data).forEach(function (_ref8) {
+        var _ref9 = (0, _slicedToArray2.default)(_ref8, 2),
+            doctype = _ref9[0],
+            data = _ref9[1];
 
         _this10.dispatch((0, _store.receiveQueryResult)(null, {
           data: data
@@ -2334,28 +2407,28 @@ var CozyClient = /*#__PURE__*/function () {
   }, {
     key: "fromOldOAuthClient",
     value: function () {
-      var _fromOldOAuthClient = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee17(oldClient, options) {
+      var _fromOldOAuthClient = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee18(oldClient, options) {
         var credentials, oauthOptions;
-        return _regenerator.default.wrap(function _callee17$(_context17) {
+        return _regenerator.default.wrap(function _callee18$(_context18) {
           while (1) {
-            switch (_context17.prev = _context17.next) {
+            switch (_context18.prev = _context18.next) {
               case 0:
                 if (!oldClient._oauth) {
-                  _context17.next = 8;
+                  _context18.next = 8;
                   break;
                 }
 
-                _context17.next = 3;
+                _context18.next = 3;
                 return oldClient.authorize();
 
               case 3:
-                credentials = _context17.sent;
+                credentials = _context18.sent;
                 oauthOptions = {
                   oauth: credentials.client,
                   token: credentials.token,
                   scope: credentials.token.scope
                 };
-                return _context17.abrupt("return", new CozyClient(_objectSpread(_objectSpread({
+                return _context18.abrupt("return", new CozyClient(_objectSpread(_objectSpread({
                   uri: oldClient._url
                 }, oauthOptions), options)));
 
@@ -2364,13 +2437,13 @@ var CozyClient = /*#__PURE__*/function () {
 
               case 9:
               case "end":
-                return _context17.stop();
+                return _context18.stop();
             }
           }
-        }, _callee17);
+        }, _callee18);
       }));
 
-      function fromOldOAuthClient(_x18, _x19) {
+      function fromOldOAuthClient(_x17, _x18) {
         return _fromOldOAuthClient.apply(this, arguments);
       }
 
@@ -2464,7 +2537,7 @@ var CozyClient = /*#__PURE__*/function () {
 CozyClient.hooks = CozyClient.hooks || {};
 CozyClient.fetchPolicies = _policies.default; //COZY_CLIENT_VERSION_PACKAGE in replaced by babel. See babel config
 
-CozyClient.version = "27.20.0";
+CozyClient.version = "27.22.1";
 
 _microee.default.mixin(CozyClient);
 

package/dist/devtools/index.js

@@ -216,6 +216,7 @@ var DevToolsPanel = function DevToolsPanel(props) {
     }
 
     var dragInfo = {
+      // @ts-ignore
       originalHeight: node.getBoundingClientRect().height,
       pageY: startEvent.pageY
     };

package/dist/models/document/documentTypeData.js

@@ -67,7 +67,7 @@ var activityLabels = ['personal_sporting_licence', 'other_activity_document'];
  * @type {Array<FinanceLabels>}
  */
 
-var financeLabels = ['tax_return', 'tax_notice', 'tax_timetable', 'receipt', 'other_tax_document', 'bank_details', 'bank_statement', 'loan_agreement', 'payment_proof_family_allowance', 'other_bank_document', 'other_revenue'];
+var financeLabels = ['tax_return', 'tax_notice', 'tax_timetable', 'pay_sheet', 'receipt', 'other_tax_document', 'bank_details', 'bank_statement', 'loan_agreement', 'payment_proof_family_allowance', 'other_bank_document', 'other_revenue'];
 /**
  * @type {Array<InvoiceLabels>}
  */

package/dist/models/document/locales/fr.json

@@ -46,7 +46,7 @@
       "pay_sheet": "Fiche de paie",
       "unemployment_benefit": "Allocations chômage",
       "pension": "Retraite",
-      "other_revenue": "Autres revenues",
+      "other_revenue": "Autres revenus",
       "gradebook": "Bulletin de notes",
       "student_card": "Carte d'étudiant",
       "school_attendance_certificate": "Certificat de scolarité",

package/dist/types.js

@@ -294,7 +294,7 @@ var _dsl = require("./queries/dsl");
  *
  * @typedef {'driver_license'|'vehicle_registration'|'car_insurance'|'mechanic_invoice'|'transport_invoice'|'other_transport_document'} TransportLabels
  *
- * @typedef {'tax_return'|'tax_notice'|'tax_timetable'|'receipt'|'other_tax_document'|'bank_details'|'bank_statement'|'loan_agreement'|'other_bank_document'|'payment_proof_family_allowance'|'other_revenue'} FinanceLabels
+ * @typedef {'tax_return'|'tax_notice'|'tax_timetable'|'pay_sheet'|'receipt'|'other_tax_document'|'bank_details'|'bank_statement'|'loan_agreement'|'other_bank_document'|'payment_proof_family_allowance'|'other_revenue'} FinanceLabels
  *
  * @typedef {'phone_invoice'|'isp_invoice'|'telecom_invoice'|'energy_invoice'|'water_invoice'|'appliance_invoice'|'web_service_invoice'|'restaurant_invoice'|'work_invoice'|'transport_invoice'|'health_invoice'|'other_invoice'} InvoiceLabels
  *
@@ -302,5 +302,31 @@ var _dsl = require("./queries/dsl");
  *
  * @typedef {IdentityLabel|FamilyLabel|WorkStudyLabels|HealthLabels|HomeLabels|TransportLabels|FinanceLabels|InvoiceLabels|ActivityLabels} ItemsLabels
  */
+
+/**
+ * Receives the URL to present to the user as a parameter, and should return a promise that resolves with the URL the user was redirected to after accepting the permissions.
+ *
+ * @callback OpenURLCallback
+ * @param {string} url - URL to present to the user
+ */
+
+/**
+ * A session code generated by the cozy-stack that can be used to create a session
+ *
+ * More information: https://docs.cozy.io/en/cozy-stack/auth/#post-authsession_code
+ *
+ * @typedef {string} SessionCode
+ */
+
+/**
+ * An object containing a code verifier and a code challenge that can be used in a
+ * PKCE verification process
+ *
+ * More information: https://docs.cozy.io/en/cozy-stack/auth/#pkce-extension
+ *
+ * @typedef {object} PKCECodes
+ * @property {string} [codeVerifier]
+ * @property {string} [codeChallenge]
+ */
 var _default = {};
 exports.default = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "27.20.0",
+  "version": "27.22.1",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -21,7 +21,7 @@
     "cozy-device-helper": "^1.12.0",
     "cozy-flags": "2.7.1",
     "cozy-logger": "^1.6.0",
-    "cozy-stack-client": "^27.19.4",
+    "cozy-stack-client": "^27.21.0",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.13",
     "microee": "^0.0.6",
@@ -71,5 +71,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "aec196270a53b798b793823e8f5c98de40de3aab"
+  "gitHead": "b0652ecd7383d34c8468b492b858049ed0aef10c"
 }

package/types/CozyClient.d.ts

@@ -558,15 +558,32 @@ declare class CozyClient {
     /**
      * Performs a complete OAuth flow, including updating the internal token at the end.
      *
-     * @param   {Function} openURLCallback Receives the URL to present to the user as a parameter, and should return a promise that resolves with the URL the user was redirected to after accepting the permissions.
+     * @param   {OpenURLCallback} openURLCallback Receives the URL to present to the user as a parameter, and should return a promise that resolves with the URL the user was redirected to after accepting the permissions.
      * @returns {Promise<object>} Contains the fetched token and the client information. These should be stored and used to restore the client.
      */
-    startOAuthFlow(openURLCallback: Function): Promise<object>;
-    authorize(openURLCallback: any): Promise<{
-        token: any;
-        infos: any;
-        client: any;
-    }>;
+    startOAuthFlow(openURLCallback: OpenURLCallback): Promise<object>;
+    /**
+     * Perform the Flagship certification process for verifying that the current running app is a genuine Cozy application
+     *
+     * This mechanism is described in https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/flagship-certification/README.md
+     */
+    certifyFlagship(): Promise<void>;
+    /**
+     * Creates an OAuth token with needed permissions for the current client.
+     * The authorization page URL generation can be overriding by passing a function pointer as `openURLCallback` parameter
+     * It is possible to skip the session creation process (when using an in-app browser) by passing a sessionCode (see https://docs.cozy.io/en/cozy-stack/auth/#post-authsession_code)
+     *
+     * @param {object} [options] - Authorization options
+     * @param {OpenURLCallback} [options.openURLCallback] - Receives the URL to present to the user as a parameter, and should return a promise that resolves with the URL the user was redirected to after accepting the permissions.
+     * @param {SessionCode} [options.sessionCode] - session code than can be added to the authorization URL to automatically create the session.
+     * @param {PKCECodes} [options.pkceCodes] - code verifier and a code challenge that should be used in the PKCE verification process.
+     * @returns {Promise<object>} Contains the fetched token and the client information. These should be stored and used to restore the client.
+     */
+    authorize({ openURLCallback, sessionCode, pkceCodes }?: {
+        openURLCallback?: OpenURLCallback;
+        sessionCode?: SessionCode;
+        pkceCodes?: PKCECodes;
+    }): Promise<object>;
     /**
      * Renews the token if, for instance, new permissions are required or token
      * has expired.
@@ -677,6 +694,9 @@ import { QueryResult } from "./types";
 import ObservableQuery from "./ObservableQuery";
 import { HydratedDocument } from "./types";
 import { QueryState } from "./types";
+import { OpenURLCallback } from "./types";
+import { SessionCode } from "./types";
+import { PKCECodes } from "./types";
 import { ReduxStore } from "./types";
 import { CozyClient as SnapshotClient } from "./testing/snapshots";
 import { OldCozyClient } from "./types";

package/types/types.d.ts

@@ -324,8 +324,28 @@ export type WorkStudyLabels = "resume" | "diploma" | "work_contract" | "pay_shee
 export type HealthLabels = "work_disability_recognition" | "health_certificate" | "health_book" | "national_health_insurance_card" | "health_insurance_card" | "prescription" | "health_invoice" | "national_health_insurance_right_certificate" | "pregnancy_medical_certificate" | "other_health_document";
 export type HomeLabels = "phone_invoice" | "isp_invoice" | "telecom_invoice" | "energy_invoice" | "water_invoice" | "house_sale_agreeement" | "building_permit" | "technical_diagnostic_record" | "lease" | "rent_receipt" | "house_insurance" | "work_quote" | "work_invoice" | "other_house_document" | "unfit_for_habitation_declaration" | "accommodation_proof";
 export type TransportLabels = "driver_license" | "vehicle_registration" | "car_insurance" | "mechanic_invoice" | "transport_invoice" | "other_transport_document";
-export type FinanceLabels = "payment_proof_family_allowance" | "tax_return" | "tax_notice" | "tax_timetable" | "receipt" | "other_tax_document" | "bank_details" | "bank_statement" | "loan_agreement" | "other_bank_document" | "other_revenue";
+export type FinanceLabels = "payment_proof_family_allowance" | "pay_sheet" | "tax_return" | "tax_notice" | "tax_timetable" | "receipt" | "other_tax_document" | "bank_details" | "bank_statement" | "loan_agreement" | "other_bank_document" | "other_revenue";
 export type InvoiceLabels = "health_invoice" | "phone_invoice" | "isp_invoice" | "telecom_invoice" | "energy_invoice" | "water_invoice" | "work_invoice" | "transport_invoice" | "appliance_invoice" | "web_service_invoice" | "restaurant_invoice" | "other_invoice";
 export type ActivityLabels = "personal_sporting_licence" | "other_activity_document";
 export type ItemsLabels = "resume" | "identity_photo" | "national_id_card" | "passport" | "residence_permit" | "family_record_book" | "birth_certificate" | "driver_license" | "other_identity_document" | "citizen_registration_certificate" | "personal_sporting_licence" | "wedding" | "pacs" | "divorce" | "large_family_card" | "caf" | "other_family_document" | "payment_proof_family_allowance" | "diploma" | "work_contract" | "pay_sheet" | "unemployment_benefit" | "pension" | "gradebook" | "student_card" | "motivation_letter" | "other_work_document" | "work_disability_recognition" | "school_attendance_certificate" | "health_certificate" | "health_book" | "national_health_insurance_card" | "health_insurance_card" | "prescription" | "health_invoice" | "national_health_insurance_right_certificate" | "pregnancy_medical_certificate" | "other_health_document" | "phone_invoice" | "isp_invoice" | "telecom_invoice" | "energy_invoice" | "water_invoice" | "house_sale_agreeement" | "building_permit" | "technical_diagnostic_record" | "lease" | "rent_receipt" | "house_insurance" | "work_quote" | "work_invoice" | "other_house_document" | "unfit_for_habitation_declaration" | "accommodation_proof" | "vehicle_registration" | "car_insurance" | "mechanic_invoice" | "transport_invoice" | "other_transport_document" | "tax_return" | "tax_notice" | "tax_timetable" | "receipt" | "other_tax_document" | "bank_details" | "bank_statement" | "loan_agreement" | "other_bank_document" | "other_revenue" | "appliance_invoice" | "web_service_invoice" | "restaurant_invoice" | "other_invoice" | "other_activity_document";
+/**
+ * Receives the URL to present to the user as a parameter, and should return a promise that resolves with the URL the user was redirected to after accepting the permissions.
+ */
+export type OpenURLCallback = (url: string) => any;
+/**
+ * A session code generated by the cozy-stack that can be used to create a session
+ *
+ * More information: https://docs.cozy.io/en/cozy-stack/auth/#post-authsession_code
+ */
+export type SessionCode = string;
+/**
+ * An object containing a code verifier and a code challenge that can be used in a
+ * PKCE verification process
+ *
+ * More information: https://docs.cozy.io/en/cozy-stack/auth/#pkce-extension
+ */
+export type PKCECodes = {
+    codeVerifier?: string;
+    codeChallenge?: string;
+};
 import { QueryDefinition } from "./queries/dsl";