cozy-client 26.0.2 → 27.2.0

package/CHANGELOG.md

@@ -3,6 +3,44 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [27.2.0](https://github.com/cozy/cozy-client/compare/v27.1.0...v27.2.0) (2021-11-15)
+
+
+### Features
+
+* Be more explicit on query warning messages ([8d9b896](https://github.com/cozy/cozy-client/commit/8d9b896693f94898e610a79da69dda6bc0ad6f0a))
+
+
+
+
+
+# [27.1.0](https://github.com/cozy/cozy-client/compare/v27.0.1...v27.1.0) (2021-11-04)
+
+**Note:** Version bump only for package cozy-client
+
+
+
+
+
+## [27.0.1](https://github.com/cozy/cozy-client/compare/v27.0.0...v27.0.1) (2021-11-04)
+
+
+### Bug Fixes
+
+* Build new OAuth client from old OAuth client ([a8ecfd0](https://github.com/cozy/cozy-client/commit/a8ecfd0344d86ba7c45e2589442bb836ba274a89))
+
+
+
+
+
+# [27.0.0](https://github.com/cozy/cozy-client/compare/v26.0.2...v27.0.0) (2021-11-03)
+
+**Note:** Version bump only for package cozy-client
+
+
+
+
+
 ## [26.0.2](https://github.com/cozy/cozy-client/compare/v26.0.1...v26.0.2) (2021-11-01)
 
 

package/dist/CozyClient.js

@@ -360,6 +360,7 @@ var CozyClient = /*#__PURE__*/function () {
      * a client with a cookie-based instance of cozy-client-js.
      *
      * @param {OldCozyClient} oldClient - An instance of the deprecated cozy-client
+     * @param {object} options - CozyStackClient options
      * @returns {CozyClient}
      */
 
@@ -699,7 +700,7 @@ var CozyClient = /*#__PURE__*/function () {
   }, {
     key: "get",
     value: function get(doctype, id) {
-      console.warn('client.get(doctype, id) is deprecated, please use Q(doctype).getById(id) to build the same query.');
+      console.warn("client.get(".concat(doctype, ", id) is deprecated, please use Q(").concat(doctype, ").getById(id) to build the same query."));
       return new _dsl.QueryDefinition({
         doctype: doctype,
         id: id
@@ -2276,7 +2277,8 @@ var CozyClient = /*#__PURE__*/function () {
      *
      * Warning: unlike other instantiators, this one needs to be awaited.
      *
-     * @param {OldCozyClient} oldClient - An instance of the deprecated cozy-client
+     * @param {OldCozyClient} oldClient - An OAuth instance of the deprecated cozy-client
+     * @param {object} options - CozyStackClient options
      * @returns {Promise<CozyClient>} An instance of a client, configured from the old client
      */
 
@@ -2284,30 +2286,32 @@ var CozyClient = /*#__PURE__*/function () {
     key: "fromOldOAuthClient",
     value: function () {
       var _fromOldOAuthClient = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee17(oldClient, options) {
-        var hasOauthCreds, token;
+        var credentials, oauthOptions;
         return _regenerator.default.wrap(function _callee17$(_context17) {
           while (1) {
             switch (_context17.prev = _context17.next) {
               case 0:
-                hasOauthCreds = oldClient._oauth && oldClient._authcreds != null;
-
-                if (!hasOauthCreds) {
+                if (!oldClient._oauth) {
                   _context17.next = 8;
                   break;
                 }
 
-                _context17.next = 4;
-                return oldClient._authcreds;
+                _context17.next = 3;
+                return oldClient.authorize();
 
-              case 4:
-                token = _context17.sent.token;
-                return _context17.abrupt("return", new CozyClient(_objectSpread({
-                  uri: oldClient._url,
-                  token: token
-                }, options)));
+              case 3:
+                credentials = _context17.sent;
+                oauthOptions = {
+                  oauth: credentials.client,
+                  token: credentials.token,
+                  scope: credentials.token.scope
+                };
+                return _context17.abrupt("return", new CozyClient(_objectSpread(_objectSpread({
+                  uri: oldClient._url
+                }, oauthOptions), options)));
 
               case 8:
-                throw new Error('Old client does not have _oauth or _authcreds, cannot instantiate a new client, check if CozyClient.fromOldClient is more suitable');
+                throw new Error('Cannot instantiate a new client: old client is not an OAuth client. CozyClient.fromOldClient might be more suitable.');
 
               case 9:
               case "end":
@@ -2411,7 +2415,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 = "26.0.2";
+CozyClient.version = "27.2.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/CozyClient.spec.js

@@ -143,17 +143,30 @@ describe('CozyClient initialization', () => {
   it('can be instantiated from an oauth-based old client', async () => {
     // Not using a real cozy-client-js here not to have to add it as a dep
     const url = 'https://testcozy.mycozy.cloud'
-    const token = 'Registration-token'
+    const oauth = {
+      clientID: 'my-client'
+      // ... other OAuth client attributes
+    }
+    const token = {
+      tokenType: 'bearer',
+      accessToken: 'access-token',
+      refreshToken: 'refresh-token',
+      scope: ['io.cozy.files']
+    }
     const oldClient = {
       _url: url,
       _oauth: true,
-      _authcreds: Promise.resolve({
+      authorize: () => ({
+        client: oauth,
         token
       })
     }
     const client = await CozyClient.fromOldOAuthClient(oldClient)
+    console.log({ stackClient: client.stackClient })
     expect(client.stackClient.uri).toBe(url)
-    expect(client.stackClient.token.token).toBe(token)
+    expect(client.stackClient.oauthOptions.clientID).toBe(oauth.clientID)
+    expect(client.stackClient.token.accessToken).toBe(token.accessToken)
+    expect(client.stackClient.scope).toBe(token.scope)
   })
 
   it('can be instantiated from dataset injected by the Stack in DOM', async () => {

package/dist/queries/dsl.js

@@ -120,13 +120,13 @@ var QueryDefinition = /*#__PURE__*/function () {
       }
 
       if (_sort.length > fieldsToIndex.length) {
-        console.warn('You should not sort on non-indexed fields');
+        console.warn("You should not sort on non-indexed fields.\n\n        Sort: ".concat(JSON.stringify(_sort), "\n\n        Indexed fields: ").concat(fieldsToIndex));
         return;
       }
 
       for (var i = 0; i < _sort.length; i++) {
         if (Object.keys(_sort[i])[0] !== fieldsToIndex[i]) {
-          console.warn('The sort order should be the same than the indexed fields');
+          console.warn("The sort order should be the same than the indexed fields.\n\n          Sort: ".concat(JSON.stringify(_sort), "\n\n          Indexed fields: ").concat(fieldsToIndex, "\n"));
           return;
         }
       }
@@ -146,13 +146,13 @@ var QueryDefinition = /*#__PURE__*/function () {
       var hasExistsFalse = (0, _findKey.default)(selector, ['$exists', false]);
 
       if (hasExistsFalse) {
-        console.warn('The "$exists: false" predicate should be defined as a partial index for better performance');
+        console.warn("The \"$exists: false\" predicate should be defined as a partial index for better performance.\n\n        Selector: ".concat(selector));
       }
 
       var hasNe = (0, _findKey.default)(selector, '$ne');
 
       if (hasNe) {
-        console.info('The use of the $ne operator is more efficient with a partial index.');
+        console.info("The use of the $ne operator is more efficient with a partial index.\n\n        Selector: ".concat(selector));
       }
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "26.0.2",
+  "version": "27.2.0",
   "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": "^26.0.0",
+    "cozy-stack-client": "^27.1.0",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.13",
     "microee": "^0.0.6",
@@ -68,5 +68,5 @@
     "react-native-inappbrowser-reborn": "^3.5.1"
   },
   "sideEffects": false,
-  "gitHead": "5b04febfcbf2feb307bc8211e94e54739646e322"
+  "gitHead": "3615a75a501a937ae3c73ada67d00b33d2ed7e62"
 }

package/types/CozyClient.d.ts

@@ -61,19 +61,21 @@ declare class CozyClient {
      * a client with a cookie-based instance of cozy-client-js.
      *
      * @param {OldCozyClient} oldClient - An instance of the deprecated cozy-client
+     * @param {object} options - CozyStackClient options
      * @returns {CozyClient}
      */
-    static fromOldClient(oldClient: OldCozyClient, options: any): CozyClient;
+    static fromOldClient(oldClient: OldCozyClient, options: object): CozyClient;
     /**
      * To help with the transition from cozy-client-js to cozy-client, it is possible to instantiate
      * a client with an OAuth-based instance of cozy-client-js.
      *
      * Warning: unlike other instantiators, this one needs to be awaited.
      *
-     * @param {OldCozyClient} oldClient - An instance of the deprecated cozy-client
+     * @param {OldCozyClient} oldClient - An OAuth instance of the deprecated cozy-client
+     * @param {object} options - CozyStackClient options
      * @returns {Promise<CozyClient>} An instance of a client, configured from the old client
      */
-    static fromOldOAuthClient(oldClient: OldCozyClient, options: any): Promise<CozyClient>;
+    static fromOldOAuthClient(oldClient: OldCozyClient, options: object): Promise<CozyClient>;
     /**
      * In konnector/service context, CozyClient can be instantiated from
      * environment variables