cozy-client 59.4.0 → 60.1.0

package/dist/CozyClient.spec.js

@@ -11,7 +11,8 @@ import {
   APP_VERSION,
   SOURCE_ACCOUNT_ID,
   SOURCE_ACCOUNT_IDENTIFIER,
-  FILE_1
+  FILE_1,
+  TODO_WITH_NONEXISTING_RELATIONSHIP
 } from './__tests__/fixtures'
 import { withIgnoreConsoleWarn } from './__tests__/console'
 
@@ -34,7 +35,7 @@ import {
   resetQuery,
   executeQueryFromState
 } from './store'
-import { HasManyFiles, Association, HasMany } from './associations'
+import { HasManyFiles, Association } from './associations'
 import mapValues from 'lodash/mapValues'
 import FileCollection from 'cozy-stack-client/dist/FileCollection'
 import logger from './logger'
@@ -1016,7 +1017,16 @@ describe('CozyClient', () => {
       const NEW_TODO = {
         _type: 'io.cozy.todos',
         label: 'Buy RAM',
-        attachments: [{ _id: 12345, _type: 'io.cozy.files' }]
+        relationships: {
+          attachments: {
+            data: [
+              {
+                _type: 'io.cozy.files',
+                _id: 1
+              }
+            ]
+          }
+        }
       }
       const EXPECTED_CREATED_TODO = { _id: 67890, ...NEW_TODO }
       const mutation = client.getDocumentSavePlan(NEW_TODO, {
@@ -1040,9 +1050,14 @@ describe('CozyClient', () => {
             id: 67890,
             type: 'io.cozy.files'
           }
-        ]
+        ],
+        relationships: { icons: [{ _id: 67890, _type: 'io.cozy.files' }] }
+      }
+      const EXPECTED_CREATED_FILE = {
+        _id: 12345,
+        _type: 'io.cozy.files',
+        relationships: { icons: [{ _id: 67890, _type: 'io.cozy.files' }] }
       }
-      const EXPECTED_CREATED_FILE = { _id: 12345, _type: 'io.cozy.files' }
       const mutation = client.getDocumentSavePlan(NEW_FILE, {
         icons: [
           {
@@ -1907,14 +1922,6 @@ describe('CozyClient', () => {
         )
         .shift()
       expect(doc.attachments).toBeInstanceOf(HasManyFiles)
-      expect(doc.authors).toBeInstanceOf(HasMany)
-    })
-
-    it('makes new documents', () => {
-      const newTodo = client.makeNewDocument('io.cozy.todos')
-      expect(newTodo._type).toBe('io.cozy.todos')
-      expect(newTodo.attachments).not.toBe(undefined)
-      expect(newTodo.attachments instanceof HasManyFiles).toBe(true)
     })
 
     it('should not fail on null (when getting absent documents from the store)', () => {
@@ -1923,6 +1930,53 @@ describe('CozyClient', () => {
         .shift()
       expect(doc).toBe(null)
     })
+
+    it('should hydrate relationships if the relationship exists', () => {
+      const resp = client.hydrateDocument(TODO_WITH_AUTHOR)
+      expect(resp.authors).not.toBe(undefined)
+      expect(resp.attachments).toBe(undefined)
+    })
+
+    it('should not hydrate relationships if the relationship does not exist', () => {
+      const resp = client.hydrateDocument(TODO_WITH_NONEXISTING_RELATIONSHIP)
+      expect(resp.authors).toBe(undefined)
+      expect(resp.attachments).toBe(undefined)
+      expect(resp.broken).toBe(undefined)
+    })
+
+    it('should not hydrate relationships if not specified', () => {
+      getQueryFromState.mockReturnValueOnce({
+        definition: { doctype: 'io.cozy.todos' },
+        data: [TODO_WITH_AUTHOR]
+      })
+      const resp = client.getQueryFromState('allTodos')
+      expect(resp.data[0].authors).toBe(undefined)
+      expect(resp.data[0].attachments).toBe(undefined)
+    })
+
+    it('should hydrate relationships only if the relationship does exist ', () => {
+      getQueryFromState.mockReturnValueOnce({
+        definition: { doctype: 'io.cozy.todos' },
+        data: [TODO_WITH_AUTHOR]
+      })
+      const resp = client.getQueryFromState('allTodos', { hydrated: true })
+      expect(resp.data[0].authors).not.toBe(undefined)
+      expect(resp.data[0].attachments).toBe(undefined)
+    })
+
+    it('should hydrate relationships if the relationship does not exist but hydration is forced', () => {
+      const newClient = new CozyClient({
+        schema: SCHEMA,
+        autoHydrate: true
+      })
+      getQueryFromState.mockReturnValueOnce({
+        definition: { doctype: 'io.cozy.todos' },
+        data: [TODO_WITH_AUTHOR]
+      })
+      const resp = newClient.getQueryFromState('allTodos')
+      expect(resp.data[0].authors).not.toBe(undefined)
+      expect(resp.data[0].attachments).not.toBe(undefined)
+    })
   })
 
   describe('serialization', () => {
@@ -2122,7 +2176,8 @@ describe('file creation', () => {
       .fn()
       .mockResolvedValueOnce({
         data: {
-          _id: '1337'
+          _id: '1337',
+          relationships: { icons: [{ _id: 1, _type: 'io.cozy.files' }] }
         }
       })
       .mockResolvedValueOnce({

package/dist/Query.spec.jsx

@@ -195,6 +195,8 @@ describe('Query', () => {
           count: 0,
           fetchedPagesCount: 0,
           data: [],
+          storeData: [],
+          relationshipNames: null,
           definition: { doctype: 'io.cozy.todos' },
           fetch: expect.any(Function),
           fetchMore: expect.any(Function),

package/dist/__tests__/fixtures.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.SCHEMA = exports.SOURCE_ACCOUNT_IDENTIFIER = exports.SOURCE_ACCOUNT_ID = exports.DOCTYPE_VERSION = exports.APP_VERSION = exports.APP_NAME = exports.FILE_2 = exports.FILE_1 = exports.TODO_WITH_AUTHOR = exports.AUTHORS = exports.TODO_WITH_RELATION = exports.TODOS = exports.TODO_4 = exports.TODO_3 = exports.TODO_2 = exports.TODO_1 = void 0;
+exports.SCHEMA = exports.SOURCE_ACCOUNT_IDENTIFIER = exports.SOURCE_ACCOUNT_ID = exports.DOCTYPE_VERSION = exports.APP_VERSION = exports.APP_NAME = exports.FILE_2 = exports.FILE_1 = exports.TODO_WITH_NONEXISTING_RELATIONSHIP = exports.TODO_WITH_AUTHOR = exports.AUTHORS = exports.TODO_WITH_RELATION = exports.TODOS = exports.TODO_4 = exports.TODO_3 = exports.TODO_2 = exports.TODO_1 = void 0;
 var TODO_1 = {
   _id: 'todo_1',
   _rev: '4-43bdf4f7123f4d748645ba9536a46daa',
@@ -88,6 +88,22 @@ var TODO_WITH_AUTHOR = {
   }
 };
 exports.TODO_WITH_AUTHOR = TODO_WITH_AUTHOR;
+var TODO_WITH_NONEXISTING_RELATIONSHIP = {
+  _id: 5,
+  _rev: '1-7f02bbb542fb4eb0805b130a80b9be1a',
+  _type: 'io.cozy.todos',
+  label: 'Todo with several authors',
+  relationships: {
+    broken: {
+      doctype: 'io.cozy.persons',
+      data: [{
+        _type: 'io.cozy.persons',
+        _id: 1
+      }]
+    }
+  }
+};
+exports.TODO_WITH_NONEXISTING_RELATIONSHIP = TODO_WITH_NONEXISTING_RELATIONSHIP;
 var FILE_1 = {
   _id: 1,
   _rev: '3-bd9bb7286a094842b954d9e86429090d',

package/dist/hooks/useQuery.js

@@ -25,6 +25,8 @@ var _context = require("../context");
 
 var _dsl = require("../queries/dsl");
 
+var _selector = require("../store/selector");
+
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
@@ -83,7 +85,7 @@ var useQuery = function useQuery(queryDefinition, options) {
       hydrated: (0, _get.default)(options, 'hydrated', true),
       singleDocData: (0, _get.default)(options, 'singleDocData', false)
     });
-  });
+  }, _selector.equalityCheckForQuery);
   (0, _react.useEffect)(function () {
     if (enabled === false) {
       return;

package/dist/hooks/useQuery.spec.jsx

@@ -107,7 +107,7 @@ describe('use query', () => {
     })
 
     expect(Object.keys(current)).toEqual(
-      expect.objectContaining([
+      expect.arrayContaining([
         'id',
         'definition',
         'fetchStatus',
@@ -120,6 +120,8 @@ describe('use query', () => {
         'count',
         'fetchedPagesCount',
         'data',
+        'storeData',
+        'relationshipNames',
         'bookmark',
         'options',
         'fetchMore',

package/dist/links/StackLink.js

@@ -288,7 +288,12 @@ var StackLink = /*#__PURE__*/function (_CozyLink) {
           id = query.id,
           ids = query.ids,
           referenced = query.referenced,
-          options = (0, _objectWithoutProperties2.default)(query, ["doctype", "selector", "id", "ids", "referenced"]);
+          sharingId = query.sharingId,
+          rawOptions = (0, _objectWithoutProperties2.default)(query, ["doctype", "selector", "id", "ids", "referenced", "sharingId"]);
+
+      var options = _objectSpread(_objectSpread({}, rawOptions), {}, {
+        driveId: undefined
+      });
 
       if (!doctype) {
         _logger.default.warn('Bad query', query);
@@ -296,7 +301,13 @@ var StackLink = /*#__PURE__*/function (_CozyLink) {
         throw new Error('No doctype found in a query definition');
       }
 
-      var collection = this.stackClient.collection(doctype);
+      if (doctype === _const.DOCTYPE_FILES && sharingId) {
+        options = _objectSpread(_objectSpread({}, options), {}, {
+          driveId: sharingId
+        });
+      }
+
+      var collection = this.stackClient.collection(doctype, options);
 
       if (id) {
         return collection.get(id, query);

package/dist/links/StackLink.spec.js

@@ -18,7 +18,10 @@ describe('StackLink', () => {
       stackClient.collection().all.mockReset()
       await link.request(query)
       expect(stackClient.collection().all).toHaveBeenCalled()
-      expect(stackClient.collection).toHaveBeenCalledWith('io.cozy.todos')
+      expect(stackClient.collection).toHaveBeenCalledWith(
+        'io.cozy.todos',
+        expect.anything()
+      )
     })
 
     it('should execute queries with a selector', async () => {
@@ -36,7 +39,10 @@ describe('StackLink', () => {
       stackClient.collection().find.mockReset()
       await link.request(query)
       expect(stackClient.collection().find).toHaveBeenCalled()
-      expect(stackClient.collection).toHaveBeenCalledWith('io.cozy.todos')
+      expect(stackClient.collection).toHaveBeenCalledWith(
+        'io.cozy.todos',
+        expect.anything()
+      )
     })
 
     it('should use all if a no sort option is given', async () => {
@@ -44,7 +50,10 @@ describe('StackLink', () => {
       stackClient.collection().all.mockReset()
       await link.request(query)
       expect(stackClient.collection().all).toHaveBeenCalled()
-      expect(stackClient.collection).toHaveBeenCalledWith('io.cozy.todos')
+      expect(stackClient.collection).toHaveBeenCalledWith(
+        'io.cozy.todos',
+        expect.anything()
+      )
     })
 
     it('should use find if a partialFilter is given', async () => {
@@ -52,7 +61,10 @@ describe('StackLink', () => {
       stackClient.collection().find.mockReset()
       await link.request(query)
       expect(stackClient.collection().find).toHaveBeenCalled()
-      expect(stackClient.collection).toHaveBeenCalledWith('io.cozy.todos')
+      expect(stackClient.collection).toHaveBeenCalledWith(
+        'io.cozy.todos',
+        expect.anything()
+      )
     })
 
     it('should use find if fields are given', async () => {
@@ -60,7 +72,10 @@ describe('StackLink', () => {
       stackClient.collection().find.mockReset()
       await link.request(query)
       expect(stackClient.collection().find).toHaveBeenCalled()
-      expect(stackClient.collection).toHaveBeenCalledWith('io.cozy.todos')
+      expect(stackClient.collection).toHaveBeenCalledWith(
+        'io.cozy.todos',
+        expect.anything()
+      )
     })
   })
 

package/dist/models/file.spec.js

@@ -430,7 +430,8 @@ describe('File Model', () => {
         'mydoc.odt'
       )
       expect(cozyClient.stackClient.collection).toHaveBeenCalledWith(
-        'io.cozy.files'
+        'io.cozy.files',
+        expect.anything()
       )
       expect(getSpy).toHaveBeenCalledWith(
         'parent',
@@ -447,7 +448,8 @@ describe('File Model', () => {
         'mydoc.odt'
       )
       expect(cozyClient.stackClient.collection).toHaveBeenCalledWith(
-        'io.cozy.files'
+        'io.cozy.files',
+        expect.anything()
       )
       expect(getSpy).toHaveBeenCalledWith(
         'parent',

package/dist/queries/dsl.js

@@ -64,6 +64,7 @@ var QueryDefinition = /*#__PURE__*/function () {
    * @param {number|null} [options.skip] - The number of docs to skip.
    * @param {import('../types').CouchDBViewCursor} [options.cursor] - The cursor to paginate views.
    * @param {string} [options.bookmark] - The bookmark to paginate mango queries.
+   * @param {string} [options.sharingId] - The id of the sharing
    */
   function QueryDefinition() {
     var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -82,6 +83,7 @@ var QueryDefinition = /*#__PURE__*/function () {
     this.skip = options.skip;
     this.cursor = options.cursor;
     this.bookmark = options.bookmark;
+    this.sharingId = options.sharingId;
   }
   /**
    * Checks if the sort order matches the index' fields order.
@@ -444,6 +446,20 @@ var QueryDefinition = /*#__PURE__*/function () {
         referenced: document
       }));
     }
+    /**
+     * Use a sharingId to query documents coming from a sharing
+     *
+     * @param {string} id - The sharing doc id
+     * @returns {QueryDefinition}  The QueryDefinition object.
+     */
+
+  }, {
+    key: "sharingById",
+    value: function sharingById(id) {
+      return new QueryDefinition(_objectSpread(_objectSpread({}, this.toDefinition()), {}, {
+        sharingId: id
+      }));
+    }
   }, {
     key: "toDefinition",
     value: function toDefinition() {
@@ -461,7 +477,8 @@ var QueryDefinition = /*#__PURE__*/function () {
         limit: this.limit,
         skip: this.skip,
         cursor: this.cursor,
-        bookmark: this.bookmark
+        bookmark: this.bookmark,
+        sharingId: this.sharingId
       };
     }
   }]);

package/dist/storage.js

@@ -54,6 +54,11 @@ var shouldDocumentBePersisted = function shouldDocumentBePersisted(document) {
     return true;
   }
 
+  if (document.driveId && document._type === 'io.cozy.files') {
+    // Special case for files in shared drives, so remote files could be locally persisted
+    return true;
+  }
+
   return false;
 };
 /**