cozy-client 32.8.1 → 33.0.2

package/dist/CozyClient.js

@@ -266,9 +266,11 @@ var CozyClient = /*#__PURE__*/function () {
 
     this.plugins = {};
 
-    try {
-      this.loadInstanceOptionsFromDOM();
-    } catch (err) {// not a critical error, we may be in node or the instance options are not on the default HTML element
+    if (!(this.stackClient instanceof _cozyStackClient.OAuthClient)) {
+      try {
+        this.loadInstanceOptionsFromDOM();
+      } catch (err) {// not a critical error, we may be in node or the instance options are not on the default HTML element
+      }
     }
 
     if (_options.uri && _options.token) {
@@ -513,9 +515,19 @@ var CozyClient = /*#__PURE__*/function () {
               case 21:
                 this.isLogged = true;
                 this.isRevoked = false;
+
+                if (!(this.stackClient instanceof _cozyStackClient.OAuthClient)) {
+                  _context2.next = 26;
+                  break;
+                }
+
+                _context2.next = 26;
+                return this.loadInstanceOptionsFromStack();
+
+              case 26:
                 this.emit('login');
 
-              case 24:
+              case 27:
               case "end":
                 return _context2.stop();
             }
@@ -2382,6 +2394,49 @@ var CozyClient = /*#__PURE__*/function () {
       this.instanceOptions = _objectSpread(_objectSpread({}, JSON.parse(cozy)), dataset);
       this.capabilities = this.instanceOptions.capabilities || null;
     }
+    /**
+     * loadInstanceOptionsFromStack - Loads the instance options from cozy-stack and exposes it through getInstanceOptions
+     *
+     * For now only retrieving capabilities is supported
+     *
+     * @returns {Promise<void>}
+     */
+
+  }, {
+    key: "loadInstanceOptionsFromStack",
+    value: function () {
+      var _loadInstanceOptionsFromStack = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee18() {
+        var _yield$this$query, data;
+
+        return _regenerator.default.wrap(function _callee18$(_context18) {
+          while (1) {
+            switch (_context18.prev = _context18.next) {
+              case 0:
+                _context18.next = 2;
+                return this.query((0, _dsl.Q)('io.cozy.settings').getById('capabilities'));
+
+              case 2:
+                _yield$this$query = _context18.sent;
+                data = _yield$this$query.data;
+                this.instanceOptions = {
+                  capabilities: data.attributes
+                };
+                this.capabilities = this.instanceOptions.capabilities || null;
+
+              case 6:
+              case "end":
+                return _context18.stop();
+            }
+          }
+        }, _callee18, this);
+      }));
+
+      function loadInstanceOptionsFromStack() {
+        return _loadInstanceOptionsFromStack.apply(this, arguments);
+      }
+
+      return loadInstanceOptionsFromStack;
+    }()
     /**
      * Directly set the data in the store, without using a query
      * This is useful for cases like Pouch replication, which wants to
@@ -2451,28 +2506,28 @@ var CozyClient = /*#__PURE__*/function () {
   }, {
     key: "fromOldOAuthClient",
     value: function () {
-      var _fromOldOAuthClient = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee18(oldClient, options) {
+      var _fromOldOAuthClient = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee19(oldClient, options) {
         var credentials, oauthOptions;
-        return _regenerator.default.wrap(function _callee18$(_context18) {
+        return _regenerator.default.wrap(function _callee19$(_context19) {
           while (1) {
-            switch (_context18.prev = _context18.next) {
+            switch (_context19.prev = _context19.next) {
               case 0:
                 if (!oldClient._oauth) {
-                  _context18.next = 8;
+                  _context19.next = 8;
                   break;
                 }
 
-                _context18.next = 3;
+                _context19.next = 3;
                 return oldClient.authorize();
 
               case 3:
-                credentials = _context18.sent;
+                credentials = _context19.sent;
                 oauthOptions = {
                   oauth: credentials.client,
                   token: credentials.token,
                   scope: credentials.token.scope
                 };
-                return _context18.abrupt("return", new CozyClient(_objectSpread(_objectSpread({
+                return _context19.abrupt("return", new CozyClient(_objectSpread(_objectSpread({
                   uri: oldClient._url
                 }, oauthOptions), options)));
 
@@ -2481,10 +2536,10 @@ var CozyClient = /*#__PURE__*/function () {
 
               case 9:
               case "end":
-                return _context18.stop();
+                return _context19.stop();
             }
           }
-        }, _callee18);
+        }, _callee19);
       }));
 
       function fromOldOAuthClient(_x17, _x18) {
@@ -2581,7 +2636,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 = "32.8.1";
+CozyClient.version = "33.0.2";
 
 _microee.default.mixin(CozyClient);
 

package/dist/CozyClient.spec.js

@@ -493,6 +493,9 @@ describe('CozyClient logout', () => {
   })
 
   it('should call reset on each link that can be reset', async () => {
+    client.query = jest.fn().mockResolvedValueOnce({
+      data: { attributes: { file_versioning: true, flat_subdomains: true } }
+    })
     links[0].reset = jest.fn()
     links[2].reset = jest.fn()
     await client.login()
@@ -510,6 +513,9 @@ describe('CozyClient logout', () => {
   })
 
   it('should call all reset even if a reset throws an error', async () => {
+    client.query = jest.fn().mockResolvedValueOnce({
+      data: { attributes: { file_versioning: true, flat_subdomains: true } }
+    })
     links[0].reset = jest.fn().mockRejectedValue(new Error('Async error'))
     links[2].reset = jest.fn()
     await client.login()
@@ -519,6 +525,9 @@ describe('CozyClient logout', () => {
   })
 
   it('should emit events', async () => {
+    client.query = jest.fn().mockResolvedValueOnce({
+      data: { attributes: { file_versioning: true, flat_subdomains: true } }
+    })
     const originalLogout = client.logout
     links[0].reset = jest.fn()
     links[2].reset = jest.fn()
@@ -537,6 +546,9 @@ describe('CozyClient logout', () => {
   })
 
   it('should unregister an oauth client', async () => {
+    client.query = jest.fn().mockResolvedValueOnce({
+      data: { attributes: { file_versioning: true, flat_subdomains: true } }
+    })
     await client.login()
     stackClient.isRegistered.mockReturnValue(true)
 

package/dist/hooks/useCapabilities.js

@@ -15,6 +15,8 @@ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/sli
 
 var _react = require("react");
 
+var _get = _interopRequireDefault(require("lodash/get"));
+
 var _dsl = require("../queries/dsl");
 
 var useCapabilities = function useCapabilities(client) {
@@ -43,7 +45,7 @@ var useCapabilities = function useCapabilities(client) {
 
               case 4:
                 capabilitiesResult = _context.sent;
-                setCapabilities(capabilitiesResult);
+                setCapabilities((0, _get.default)(capabilitiesResult, 'data.attributes', {}));
                 setFetchStatus('loaded');
                 _context.next = 12;
                 break;
@@ -66,7 +68,12 @@ var useCapabilities = function useCapabilities(client) {
       };
     }();
 
-    fetchData();
+    if (client.capabilities) {
+      setCapabilities(client.capabilities);
+      setFetchStatus('loaded');
+    } else {
+      fetchData();
+    }
   }, [client]);
   return {
     capabilities: capabilities,

package/dist/hooks/useCapabilities.spec.jsx

@@ -3,6 +3,10 @@ import useCapabilities from './useCapabilities'
 describe('useCapabilities', () => {
   const mockClient = { query: jest.fn(), get: jest.fn() }
 
+  beforeEach(() => {
+    jest.clearAllMocks()
+  })
+
   it('should change loading status', async () => {
     mockClient.query.mockResolvedValue({ data: [] })
     const { result, waitForNextUpdate } = renderHook(() =>
@@ -40,13 +44,22 @@ describe('useCapabilities', () => {
 
     await waitForNextUpdate()
     expect(result.current.capabilities).toEqual({
-      data: {
-        type: 'io.cozy.settings',
-        id: 'io.cozy.settings.capabilities',
-        attributes: { file_versioning: true, flat_subdomains: true },
-        meta: {},
-        links: { self: '/settings/capabilities' }
-      }
+      file_versioning: true,
+      flat_subdomains: true
+    })
+  })
+
+  it(`should return client's capabilities if defined`, async () => {
+    mockClient.capabilities = {
+      file_versioning: false,
+      flat_subdomains: false
+    }
+    const { result } = renderHook(() => useCapabilities(mockClient))
+
+    expect(result.current.capabilities).toEqual({
+      file_versioning: false,
+      flat_subdomains: false
     })
+    expect(mockClient.query).not.toHaveBeenCalled()
   })
 })

package/dist/models/file.js

@@ -100,8 +100,10 @@ var isDirectory = function isDirectory(file) {
   return file && file.type === DIR_TYPE;
 };
 /**
+ * Is file param a correct note
  *
  * @param {IOCozyFile} file io.cozy.files
+ * @returns {boolean}
  */
 
 

package/dist/types.js

@@ -163,12 +163,28 @@ var _dsl = require("./queries/dsl");
  * @property {object} [cozyMetadata] - Cozy Metadata
  */
 
+/**
+ * Metadata on io.cozy.files documents
+ *
+ * This is a first step, to continue
+ *
+ * Filled according to:
+ * https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.files_metadata/
+ * https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.notes/
+ *
+ * @typedef {object} FileMetadata - A io.cozy.files document's metadata
+ * @property {object} [content] - The Note's content. See https://prosemirror.net/docs/ref/#model for more informations
+ * @property {object} [schema] - the schema used by prosemirror (with notes and marks serialized as arrays to preserve the order).
+ * @property {string} [title] - the initial title of the note (that will also be used for the file name)
+ * @property {number} [version] - Number of a note
+ */
+
 /**
  * @typedef {object} FileDocument - An io.cozy.files document
  * @property {string} _id - Id of the file
  * @property {FilesDoctype} _type - Doctype of the file
  * @property {string} name - Name of the file
- * @property {object} metadata - Metadata of the file
+ * @property {FileMetadata} metadata - Metadata of the file
  * @property {string} type - Type of the file
  * @property {string} class - Class of the file
  * @property {string} mime - Mime of the file

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "32.8.1",
+  "version": "33.0.2",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -18,7 +18,7 @@
     "@types/jest": "^26.0.20",
     "@types/lodash": "^4.14.170",
     "btoa": "^1.2.1",
-    "cozy-stack-client": "^32.8.1",
+    "cozy-stack-client": "^33.0.0",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.13",
     "microee": "^0.0.6",
@@ -73,5 +73,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "87601ffe928c19779744d7f57502d9ba9a688f37"
+  "gitHead": "c00ba115384a2ba0f562adb4fa5e141ea64dbe45"
 }

package/types/CozyClient.d.ts

@@ -684,6 +684,14 @@ declare class CozyClient {
      * @returns {void}
      */
     loadInstanceOptionsFromDOM(selector?: string): void;
+    /**
+     * loadInstanceOptionsFromStack - Loads the instance options from cozy-stack and exposes it through getInstanceOptions
+     *
+     * For now only retrieving capabilities is supported
+     *
+     * @returns {Promise<void>}
+     */
+    loadInstanceOptionsFromStack(): Promise<void>;
     /**
      * Directly set the data in the store, without using a query
      * This is useful for cases like Pouch replication, which wants to

package/types/types.d.ts

@@ -174,6 +174,27 @@ export type CozyClientDocument = {
      */
     cozyMetadata?: object;
 };
+/**
+ * - A io.cozy.files document's metadata
+ */
+export type FileMetadata = {
+    /**
+     * - The Note's content. See https://prosemirror.net/docs/ref/#model for more informations
+     */
+    content?: object;
+    /**
+     * - the schema used by prosemirror (with notes and marks serialized as arrays to preserve the order).
+     */
+    schema?: object;
+    /**
+     * - the initial title of the note (that will also be used for the file name)
+     */
+    title?: string;
+    /**
+     * - Number of a note
+     */
+    version?: number;
+};
 /**
  * - An io.cozy.files document
  */
@@ -193,7 +214,7 @@ export type FileDocument = {
     /**
      * - Metadata of the file
      */
-    metadata: object;
+    metadata: FileMetadata;
     /**
      * - Type of the file
      */