cozy-client 27.4.0 → 27.6.2

package/CHANGELOG.md

@@ -3,6 +3,62 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [27.6.2](https://github.com/cozy/cozy-client/compare/v27.6.1...v27.6.2) (2021-12-16)
+
+
+### Bug Fixes
+
+* Update dependency date-fns to v2.27.0 ([5ec7911](https://github.com/cozy/cozy-client/commit/5ec7911352072a72de99ec68f545f0b36c56c990))
+
+
+
+
+
+## [27.6.1](https://github.com/cozy/cozy-client/compare/v27.6.0...v27.6.1) (2021-12-15)
+
+
+### Bug Fixes
+
+* **filename:** Get illegal characters from file name and returns them ([7c00526](https://github.com/cozy/cozy-client/commit/7c00526283dd865aea929c2983d32f7a12121c65))
+
+
+
+
+
+# [27.6.0](https://github.com/cozy/cozy-client/compare/v27.5.1...v27.6.0) (2021-12-13)
+
+
+### Features
+
+* Add some helpers for model file ([e074067](https://github.com/cozy/cozy-client/commit/e0740674bb250b979fc3a6bfeace771de3d3c2fd))
+
+
+
+
+
+## [27.5.1](https://github.com/cozy/cozy-client/compare/v27.5.0...v27.5.1) (2021-12-01)
+
+
+### Bug Fixes
+
+* Re-export associations helpers ([9a8d841](https://github.com/cozy/cozy-client/commit/9a8d84135762a1cf0ce29c7da247ca9a4ec617e5)), closes [#1076](https://github.com/cozy/cozy-client/issues/1076)
+
+
+
+
+
+# [27.5.0](https://github.com/cozy/cozy-client/compare/v27.4.0...v27.5.0) (2021-12-01)
+
+
+### Features
+
+* Added referencedBy helpers ([2bd77e4](https://github.com/cozy/cozy-client/commit/2bd77e451eab26b85b21b41db522a7da6378672b))
+* Adding types around references ([6d9c8aa](https://github.com/cozy/cozy-client/commit/6d9c8aade0ece644674b9adfee1b08b8eff7482e))
+
+
+
+
+
 # [27.4.0](https://github.com/cozy/cozy-client/compare/v27.3.2...v27.4.0) (2021-11-25)
 
 

package/dist/CozyClient.js

@@ -2452,7 +2452,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.4.0";
+CozyClient.version = "27.6.2";
 
 _microee.default.mixin(CozyClient);
 

package/dist/__tests__/fixtures.js

@@ -92,7 +92,8 @@ var FILE_1 = {
   _id: 1,
   _rev: '3-bd9bb7286a094842b954d9e86429090d',
   _type: 'io.cozy.files',
-  label: 'File 1'
+  label: 'File 1',
+  name: 'New document name'
 };
 exports.FILE_1 = FILE_1;
 var FILE_2 = {

package/dist/associations/helpers.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.create = exports.resolveClass = exports.attachRelationships = exports.responseToRelationship = exports.pickTypeAndId = void 0;
+exports.getReferencedById = exports.getReferencedBy = exports.isReferencedById = exports.isReferencedBy = exports.create = exports.resolveClass = exports.attachRelationships = exports.responseToRelationship = exports.pickTypeAndId = void 0;
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
@@ -25,6 +25,8 @@ var _HasManyInPlace = _interopRequireDefault(require("./HasManyInPlace"));
 
 var _HasManyFiles = _interopRequireDefault(require("./HasManyFiles"));
 
+var _types = require("../types");
+
 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; }
@@ -124,5 +126,83 @@ var create = function create(target, _ref, accessors) {
 
   return new type(target, name, doctype, accessors);
 };
+/**
+ * Checks if the file is referenced by a specific doctype
+ *
+ * @param {IOCozyFile} file - io.cozy.files document
+ * @param {Doctype} referencedBy - Doctype where document is referenced
+ * @returns {boolean} If a reference is found
+ */
+
+
+exports.create = create;
+
+var isReferencedBy = function isReferencedBy(file, referencedBy) {
+  var _file$relationships, _file$relationships$r;
+
+  var references = (file === null || file === void 0 ? void 0 : (_file$relationships = file.relationships) === null || _file$relationships === void 0 ? void 0 : (_file$relationships$r = _file$relationships.referenced_by) === null || _file$relationships$r === void 0 ? void 0 : _file$relationships$r.data) || (file === null || file === void 0 ? void 0 : file.referenced_by) || [];
+  return references.some(function (reference) {
+    return reference.type === referencedBy;
+  });
+};
+/**
+ * Checks if the file is referenced by a specific doctype and a specific Id of that reference
+ *
+ * @param {IOCozyFile} file - io.cozy.files document
+ * @param {Doctype} referencedBy - Doctype where document is referenced
+ * @param {string} referencedId - Id of the referenced document
+ * @returns {boolean} If a reference is found
+ */
+
+
+exports.isReferencedBy = isReferencedBy;
+
+var isReferencedById = function isReferencedById(file, referencedBy, referencedId) {
+  var _file$relationships2, _file$relationships2$;
+
+  var references = (file === null || file === void 0 ? void 0 : (_file$relationships2 = file.relationships) === null || _file$relationships2 === void 0 ? void 0 : (_file$relationships2$ = _file$relationships2.referenced_by) === null || _file$relationships2$ === void 0 ? void 0 : _file$relationships2$.data) || (file === null || file === void 0 ? void 0 : file.referenced_by) || [];
+  return references.some(function (reference) {
+    return reference.type === referencedBy && reference.id === referencedId;
+  });
+};
+/**
+ * Get array of reference by an specific doctype
+ *
+ * @param {IOCozyFile} file - io.cozy.files document
+ * @param {Doctype} referencedBy - Doctype where document is referenced
+ * @returns {Reference[]} Array of references found
+ */
+
+
+exports.isReferencedById = isReferencedById;
+
+var getReferencedBy = function getReferencedBy(file, referencedBy) {
+  var _file$relationships3, _file$relationships3$;
+
+  var references = (file === null || file === void 0 ? void 0 : (_file$relationships3 = file.relationships) === null || _file$relationships3 === void 0 ? void 0 : (_file$relationships3$ = _file$relationships3.referenced_by) === null || _file$relationships3$ === void 0 ? void 0 : _file$relationships3$.data) || (file === null || file === void 0 ? void 0 : file.referenced_by) || [];
+  return references.filter(function (reference) {
+    return reference.type === referencedBy;
+  });
+};
+/**
+ * Get array of reference by an specific doctype and a specific Id of that reference
+ *
+ * @param {IOCozyFile} file - io.cozy.files document
+ * @param {Doctype} referencedBy - Doctype where document is referenced
+ * @param {string} referencedId - Id of the referenced document
+ * @returns {Reference[]} Array of the reference found
+ */
+
+
+exports.getReferencedBy = getReferencedBy;
+
+var getReferencedById = function getReferencedById(file, referencedBy, referencedId) {
+  var _file$relationships4, _file$relationships4$;
+
+  var references = (file === null || file === void 0 ? void 0 : (_file$relationships4 = file.relationships) === null || _file$relationships4 === void 0 ? void 0 : (_file$relationships4$ = _file$relationships4.referenced_by) === null || _file$relationships4$ === void 0 ? void 0 : _file$relationships4$.data) || (file === null || file === void 0 ? void 0 : file.referenced_by) || [];
+  return references.filter(function (reference) {
+    return reference.type === referencedBy && reference.id === referencedId;
+  });
+};
 
-exports.create = create;
+exports.getReferencedById = getReferencedById;

package/dist/associations/helpers.spec.js

@@ -1,123 +1,237 @@
-import { attachRelationships } from './helpers'
-
-describe('Attaching relationships', () => {
-  const tasks = {
-    data: [
-      { _id: 1, _type: 'io.cozy.tasks' },
-      { _id: 2, _type: 'io.cozy.tasks' }
-    ]
-  }
-  const todos = {
-    data: [
-      { _id: 3, _type: 'io.cozy.todos' },
-      { _id: 4, _type: 'io.cozy.todos' }
-    ]
-  }
-
-  it('should attach to a single document', () => {
-    const doc = {
-      _id: 1
+import {
+  attachRelationships,
+  isReferencedBy,
+  isReferencedById,
+  getReferencedBy,
+  getReferencedById
+} from './helpers'
+
+describe('Associations helpers', () => {
+  describe('Attaching relationships', () => {
+    const tasks = {
+      data: [
+        { _id: 1, _type: 'io.cozy.tasks' },
+        { _id: 2, _type: 'io.cozy.tasks' }
+      ]
     }
-    const relationships = {
-      1: {
-        tasks
-      }
+    const todos = {
+      data: [
+        { _id: 3, _type: 'io.cozy.todos' },
+        { _id: 4, _type: 'io.cozy.todos' }
+      ]
     }
-    const withRelationships = attachRelationships({ data: doc }, relationships)
-    expect(withRelationships.data.relationships).toEqual({
-      tasks
-    })
-  })
 
-  it('should attach to multiple document', () => {
-    const docs = [
-      {
+    it('should attach to a single document', () => {
+      const doc = {
         _id: 1
-      },
-      {
-        _id: 2
       }
-    ]
-    const relationships = {
-      1: {
+      const relationships = {
+        1: {
+          tasks
+        }
+      }
+      const withRelationships = attachRelationships(
+        { data: doc },
+        relationships
+      )
+      expect(withRelationships.data.relationships).toEqual({
         tasks
-      },
-      2: {
-        todos
+      })
+    })
+
+    it('should attach to multiple document', () => {
+      const docs = [
+        {
+          _id: 1
+        },
+        {
+          _id: 2
+        }
+      ]
+      const relationships = {
+        1: {
+          tasks
+        },
+        2: {
+          todos
+        }
       }
-    }
-    const withRelationships = attachRelationships({ data: docs }, relationships)
-    expect(withRelationships.data[0].relationships).toEqual({
-      tasks
+      const withRelationships = attachRelationships(
+        { data: docs },
+        relationships
+      )
+      expect(withRelationships.data[0].relationships).toEqual({
+        tasks
+      })
+      expect(withRelationships.data[1].relationships).toEqual({
+        todos
+      })
     })
-    expect(withRelationships.data[1].relationships).toEqual({
-      todos
+
+    it('should add missing relationships', () => {
+      const doc = {
+        _id: 1,
+        relationships: {
+          tasks
+        }
+      }
+      const relationships = {
+        1: {
+          tasks,
+          todos
+        }
+      }
+      const withRelationships = attachRelationships(
+        { data: doc },
+        relationships
+      )
+      expect(withRelationships.data.relationships.tasks).toEqual(tasks)
+      expect(withRelationships.data.relationships.todos).toEqual(todos)
     })
-  })
 
-  it('should add missing relationships', () => {
-    const doc = {
-      _id: 1,
-      relationships: {
-        tasks
+    it('should preserve existing relationships', () => {
+      const doc = {
+        _id: 1,
+        relationships: {
+          tasks
+        }
       }
-    }
-    const relationships = {
-      1: {
-        tasks,
-        todos
+      const relationships = {
+        1: {
+          todos
+        }
       }
-    }
-    const withRelationships = attachRelationships({ data: doc }, relationships)
-    expect(withRelationships.data.relationships.tasks).toEqual(tasks)
-    expect(withRelationships.data.relationships.todos).toEqual(todos)
-  })
+      const withRelationships = attachRelationships(
+        { data: doc },
+        relationships
+      )
+      expect(withRelationships.data.relationships.tasks).toEqual(tasks)
+      expect(withRelationships.data.relationships.todos).toEqual(todos)
+    })
 
-  it('should preserve existing relationships', () => {
-    const doc = {
-      _id: 1,
-      relationships: {
-        tasks
+    it('should work when there are no new relationships', () => {
+      const doc = {
+        _id: 1,
+        relationships: {
+          tasks
+        }
       }
-    }
-    const relationships = {
-      1: {
-        todos
+      const relationships = {
+        2: {
+          todos
+        }
       }
-    }
-    const withRelationships = attachRelationships({ data: doc }, relationships)
-    expect(withRelationships.data.relationships.tasks).toEqual(tasks)
-    expect(withRelationships.data.relationships.todos).toEqual(todos)
-  })
+      const withRelationships = attachRelationships(
+        { data: doc },
+        relationships
+      )
+      expect(withRelationships.data.relationships.tasks).toEqual(tasks)
+      expect(Object.keys(withRelationships.data.relationships).length).toEqual(
+        1
+      )
+    })
 
-  it('should work when there are no new relationships', () => {
-    const doc = {
-      _id: 1,
-      relationships: {
-        tasks
+    it('should attach relationships when the document has an empty relationship object', () => {
+      const doc = {
+        _id: 1,
+        relationships: {}
       }
-    }
-    const relationships = {
-      2: {
-        todos
+      const relationships = {
+        1: {
+          tasks
+        }
       }
-    }
-    const withRelationships = attachRelationships({ data: doc }, relationships)
-    expect(withRelationships.data.relationships.tasks).toEqual(tasks)
-    expect(Object.keys(withRelationships.data.relationships).length).toEqual(1)
+      const withRelationships = attachRelationships(
+        { data: doc },
+        relationships
+      )
+      expect(withRelationships.data.relationships.tasks).toEqual(tasks)
+    })
   })
 
-  it('should attach relationships when the document has an empty relationship object', () => {
-    const doc = {
-      _id: 1,
-      relationships: {}
-    }
-    const relationships = {
-      1: {
-        tasks
+  describe('referencedBy', () => {
+    const mockFile = {
+      _id: '123',
+      name: 'fakeFile',
+      relationships: {
+        referenced_by: {
+          data: [
+            {
+              id: '123',
+              type: 'io.cozy.contacts'
+            },
+            {
+              id: '456',
+              type: 'io.cozy.contacts'
+            }
+          ]
+        }
       }
     }
-    const withRelationships = attachRelationships({ data: doc }, relationships)
-    expect(withRelationships.data.relationships.tasks).toEqual(tasks)
+    describe('isReferencedBy', () => {
+      it('should return "true"', () => {
+        const result = isReferencedBy(mockFile, 'io.cozy.contacts')
+
+        expect(result).toBe(true)
+      })
+      it('should return "false"', () => {
+        const result = isReferencedBy(mockFile, 'io.cozy.xxx')
+
+        expect(result).toBe(false)
+      })
+    })
+
+    describe('isReferencedById', () => {
+      it('should return "true"', () => {
+        const result = isReferencedById(mockFile, 'io.cozy.contacts', '123')
+
+        expect(result).toBe(true)
+      })
+      it('should return "false"', () => {
+        const result = isReferencedById(mockFile, 'io.cozy.contacts', '789')
+
+        expect(result).toBe(false)
+      })
+    })
+
+    describe('getReferencedBy', () => {
+      it('should return correct array of reference', () => {
+        const result = getReferencedBy(mockFile, 'io.cozy.contacts')
+
+        expect(result).toEqual([
+          {
+            id: '123',
+            type: 'io.cozy.contacts'
+          },
+          {
+            id: '456',
+            type: 'io.cozy.contacts'
+          }
+        ])
+      })
+      it('should return empty array', () => {
+        const result = getReferencedBy(mockFile, 'io.cozy.xxx')
+
+        expect(result).toEqual([])
+      })
+    })
+
+    describe('getReferencedById', () => {
+      it('should return array of reference with only the reference with id "123"', () => {
+        const result = getReferencedById(mockFile, 'io.cozy.contacts', '123')
+
+        expect(result).toEqual([
+          {
+            id: '123',
+            type: 'io.cozy.contacts'
+          }
+        ])
+      })
+      it('should return empty array', () => {
+        const result = getReferencedById(mockFile, 'io.cozy.contacts', '789')
+
+        expect(result).toEqual([])
+      })
+    })
   })
 })

package/dist/associations/index.js

@@ -59,6 +59,30 @@ Object.defineProperty(exports, "create", {
     return _helpers.create;
   }
 });
+Object.defineProperty(exports, "isReferencedBy", {
+  enumerable: true,
+  get: function get() {
+    return _helpers.isReferencedBy;
+  }
+});
+Object.defineProperty(exports, "isReferencedById", {
+  enumerable: true,
+  get: function get() {
+    return _helpers.isReferencedById;
+  }
+});
+Object.defineProperty(exports, "getReferencedBy", {
+  enumerable: true,
+  get: function get() {
+    return _helpers.getReferencedBy;
+  }
+});
+Object.defineProperty(exports, "getReferencedById", {
+  enumerable: true,
+  get: function get() {
+    return _helpers.getReferencedById;
+  }
+});
 
 var _HasManyFiles = _interopRequireDefault(require("./HasManyFiles"));
 

package/dist/index.js

@@ -22,6 +22,10 @@ var _exportNames = {
   HasOneInPlace: true,
   HasManyInPlace: true,
   HasManyTriggers: true,
+  isReferencedBy: true,
+  isReferencedById: true,
+  getReferencedBy: true,
+  getReferencedById: true,
   dehydrate: true,
   generateWebLink: true,
   cancelable: true,
@@ -132,16 +136,40 @@ Object.defineProperty(exports, "HasManyTriggers", {
     return _associations.HasManyTriggers;
   }
 });
+Object.defineProperty(exports, "isReferencedBy", {
+  enumerable: true,
+  get: function get() {
+    return _helpers.isReferencedBy;
+  }
+});
+Object.defineProperty(exports, "isReferencedById", {
+  enumerable: true,
+  get: function get() {
+    return _helpers.isReferencedById;
+  }
+});
+Object.defineProperty(exports, "getReferencedBy", {
+  enumerable: true,
+  get: function get() {
+    return _helpers.getReferencedBy;
+  }
+});
+Object.defineProperty(exports, "getReferencedById", {
+  enumerable: true,
+  get: function get() {
+    return _helpers.getReferencedById;
+  }
+});
 Object.defineProperty(exports, "dehydrate", {
   enumerable: true,
   get: function get() {
-    return _helpers.dehydrate;
+    return _helpers2.dehydrate;
   }
 });
 Object.defineProperty(exports, "generateWebLink", {
   enumerable: true,
   get: function get() {
-    return _helpers.generateWebLink;
+    return _helpers2.generateWebLink;
   }
 });
 Object.defineProperty(exports, "cancelable", {
@@ -248,7 +276,9 @@ var _dsl = require("./queries/dsl");
 
 var _associations = require("./associations");
 
-var _helpers = require("./helpers");
+var _helpers = require("./associations/helpers");
+
+var _helpers2 = require("./helpers");
 
 var _utils = require("./utils");
 

package/dist/models/file.js

@@ -8,7 +8,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.normalize = normalize;
 exports.ensureFilePath = ensureFilePath;
 exports.getParentFolderId = getParentFolderId;
-exports.doMobileUpload = exports.readMobileFile = exports.uploadFileWithConflictStrategy = exports.generateFileNameForRevision = exports.generateNewFileNameOnConflict = exports.overrideFileForPath = exports.move = exports.getFullpath = exports.hasMetadataAttribute = exports.isReferencedByAlbum = exports.fetchFilesByQualificationRules = exports.saveFileQualification = exports.isSharingShorcutNew = exports.isSharingShortcutNew = exports.isSharingShorcut = exports.isSharingShortcut = exports.getSharingShortcutTargetDoctype = exports.getSharingShortcutTargetMime = exports.getSharingShortcutStatus = exports.isShortcut = exports.shouldBeOpenedByOnlyOffice = exports.isOnlyOfficeFile = exports.isNote = exports.isDirectory = exports.isFile = exports.splitFilename = exports.ALBUMS_DOCTYPE = void 0;
+exports.isFromKonnector = exports.hasCertifications = exports.hasQualifications = exports.isPlainText = exports.doMobileUpload = exports.readMobileFile = exports.uploadFileWithConflictStrategy = exports.generateFileNameForRevision = exports.generateNewFileNameOnConflict = exports.overrideFileForPath = exports.move = exports.getFullpath = exports.hasMetadataAttribute = exports.isReferencedByAlbum = exports.fetchFilesByQualificationRules = exports.saveFileQualification = exports.isSharingShorcutNew = exports.isSharingShortcutNew = exports.isSharingShorcut = exports.isSharingShortcut = exports.getSharingShortcutTargetDoctype = exports.getSharingShortcutTargetMime = exports.getSharingShortcutStatus = exports.isShortcut = exports.shouldBeOpenedByOnlyOffice = exports.isOnlyOfficeFile = exports.isNote = exports.isDirectory = exports.isFile = exports.splitFilename = exports.ALBUMS_DOCTYPE = void 0;
 
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
@@ -57,7 +57,7 @@ var FILENAME_WITH_EXTENSION_REGEX = /(.+)(\..*)$/;
  */
 
 var splitFilename = function splitFilename(file) {
-  if (!(0, _isString.default)(file.name)) throw new Error('file should have a name property ');
+  if (!(0, _isString.default)(file.name)) throw new Error('file should have a name property');
 
   if (file.type === 'file') {
     var match = file.name.match(FILENAME_WITH_EXTENSION_REGEX);
@@ -483,7 +483,7 @@ var getFullpath = /*#__PURE__*/function () {
  *
  * @param {CozyClient} client             - The CozyClient instance
  * @param   {string} fileId               - The file's id (required)
- * @param   {object} destination
+ * @param   {object} destination          - The destination object containing:
  * @param   {string} destination.folderId - The destination folder's id (required)
  * @param   {string} destination.path     - The file's path after the move (optional, used to optimize performance in case of conflict)
  * @param   {boolean} force               - Whether we should overwrite, i.e. put to trash, the destination in case of conflict (defaults to false).
@@ -976,5 +976,52 @@ var doMobileUpload = /*#__PURE__*/function () {
     return _ref12.apply(this, arguments);
   };
 }();
+/**
+ * @param {string} [mimeType=''] - Mime type of file
+ * @param {string} [fileName=''] - Name of file
+ * @returns {boolean}
+ */
+
+
+exports.doMobileUpload = doMobileUpload;
+
+var isPlainText = function isPlainText() {
+  var mimeType = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
+  var fileName = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
+  return mimeType ? /^text\//.test(mimeType) : /\.(txt|md)$/.test(fileName);
+};
+/**
+ * @param {IOCozyFile} file - io.cozy.files document
+ * @returns {boolean}
+ */
+
+
+exports.isPlainText = isPlainText;
+
+var hasQualifications = function hasQualifications(file) {
+  return (0, _has.default)(file, 'metadata.qualification');
+};
+/**
+ * @param {IOCozyFile} file - io.cozy.files document
+ * @returns {boolean}
+ */
+
+
+exports.hasQualifications = hasQualifications;
+
+var hasCertifications = function hasCertifications(file) {
+  return (0, _get.default)(file, 'metadata.carbonCopy', false) || (0, _get.default)(file, 'metadata.electronicSafe', false);
+};
+/**
+ * @param {IOCozyFile} file - io.cozy.files document
+ * @returns {boolean}
+ */
+
+
+exports.hasCertifications = hasCertifications;
+
+var isFromKonnector = function isFromKonnector(file) {
+  return (0, _has.default)(file, 'cozyMetadata.sourceAccount');
+};
 
-exports.doMobileUpload = doMobileUpload;
+exports.isFromKonnector = isFromKonnector;

package/dist/models/file.spec.js

@@ -154,6 +154,53 @@ describe('File Model', () => {
     ).toBe(false)
   })
 
+  describe('hasQualifications', () => {
+    it.each`
+      file                                                                      | result
+      ${{ name: 'file01', metadata: { qualification: { label: 'passport' } } }} | ${true}
+      ${{ name: 'file02', metadata: {} }}                                       | ${false}
+      ${{ name: 'file03' }}                                                     | ${false}
+    `(
+      `should test if a $file.name has a qualification or not`,
+      ({ file, result }) => {
+        expect(fileModel.hasQualifications(file)).toEqual(result)
+      }
+    )
+  })
+
+  describe('hasCertifications', () => {
+    it.each`
+      file                                                                          | result
+      ${{ name: 'file01', metadata: { carbonCopy: true } }}                         | ${true}
+      ${{ name: 'file02', metadata: { electronicSafe: true } }}                     | ${true}
+      ${{ name: 'file03', metadata: { carbonCopy: true, electronicSafe: false } }}  | ${true}
+      ${{ name: 'file04', metadata: { carbonCopy: false, electronicSafe: true } }}  | ${true}
+      ${{ name: 'file05', metadata: { carbonCopy: true, electronicSafe: true } }}   | ${true}
+      ${{ name: 'file06', metadata: { carbonCopy: false, electronicSafe: false } }} | ${false}
+      ${{ name: 'file07', metadata: {} }}                                           | ${false}
+      ${{ name: 'file08' }}                                                         | ${false}
+    `(
+      `should test if a $file.name has a certification or not`,
+      ({ file, result }) => {
+        expect(fileModel.hasCertifications(file)).toEqual(result)
+      }
+    )
+  })
+
+  describe('isFromKonnector', () => {
+    it.each`
+      file                                                                      | result
+      ${{ name: 'file01', cozyMetadata: { sourceAccount: 'sourceAccountId' } }} | ${true}
+      ${{ name: 'file02', cozyMetadata: {} }}                                   | ${false}
+      ${{ name: 'file03' }}                                                     | ${false}
+    `(
+      `should test if a $file.name is from connector or not`,
+      ({ file, result }) => {
+        expect(fileModel.isFromKonnector(file)).toEqual(result)
+      }
+    )
+  })
+
   describe('normalizeFile', () => {
     const id = 'uuid123'
     const type = 'directory'
@@ -183,36 +230,23 @@ describe('File Model', () => {
   })
 
   describe('splitFilename', () => {
-    const joinName = ({ filename, extension }) => filename + extension
-    const mkFile = expectation => ({
-      type: 'file',
-      name: joinName(expectation)
-    })
-    const { stringify } = JSON
-
-    const scenarios = [
-      { filename: 'file', extension: '.ext' },
-      { filename: 'file', extension: '' },
-      { filename: 'file.html', extension: '.ejs' },
-      { filename: 'file', extension: '.' },
-      { filename: 'file.', extension: '.' },
-      { filename: 'file.', extension: '.ext' },
-      { filename: '.file', extension: '' },
-      { filename: '.file', extension: '.ext' }
-    ]
-
-    for (const expectation of scenarios) {
-      it(`splits ${stringify(joinName(expectation))} into ${stringify(
-        expectation
-      )}`, () => {
-        expect(fileModel.splitFilename(mkFile(expectation))).toEqual(
-          expectation
-        )
-      })
-    }
-
+    it.each`
+      opts                                       | result
+      ${{ type: 'file', name: 'file.ext' }}      | ${{ filename: 'file', extension: '.ext' }}
+      ${{ type: 'file', name: 'file' }}          | ${{ filename: 'file', extension: '' }}
+      ${{ type: 'file', name: 'file.html.ext' }} | ${{ filename: 'file.html', extension: '.ext' }}
+      ${{ type: 'file', name: 'file.' }}         | ${{ filename: 'file', extension: '.' }}
+      ${{ type: 'file', name: 'file..' }}        | ${{ filename: 'file.', extension: '.' }}
+      ${{ type: 'file', name: 'file..ext' }}     | ${{ filename: 'file.', extension: '.ext' }}
+      ${{ type: 'file', name: '.file' }}         | ${{ filename: '.file', extension: '' }}
+      ${{ type: 'file', name: '.file.ext' }}     | ${{ filename: '.file', extension: '.ext' }}
+    `(`should splits $opts.name into $result`, ({ opts, result }) => {
+      expect(fileModel.splitFilename(opts)).toEqual(result)
+    })
     it('should throw an error if the file is not correct', () => {
-      expect(() => fileModel.splitFilename({})).toThrow()
+      expect(() => fileModel.splitFilename({})).toThrow(
+        'file should have a name property'
+      )
       expect(() => fileModel.splitFilename({ name: null })).toThrow()
       expect(() => fileModel.splitFilename({ name: '' })).not.toThrow()
     })
@@ -510,48 +544,6 @@ describe('File Model', () => {
     })
   })
 
-  describe('splitFilename', () => {
-    const name = ({ filename, extension }) => filename + extension
-    const file = expectation => ({ type: 'file', name: name(expectation) })
-    const { stringify } = JSON
-
-    const scenarios = [
-      { filename: 'file', extension: '.ext' },
-      { filename: 'file', extension: '' },
-      { filename: 'file.html', extension: '.ejs' },
-      { filename: 'file', extension: '.' },
-      { filename: 'file.', extension: '.' },
-      { filename: 'file.', extension: '.ext' },
-      { filename: '.file', extension: '' },
-      { filename: '.file', extension: '.ext' }
-    ]
-
-    for (const expectation of scenarios) {
-      it(`splits ${stringify(name(expectation))} into ${stringify(
-        expectation
-      )}`, () => {
-        expect(fileModel.splitFilename(file(expectation))).toEqual(expectation)
-      })
-    }
-
-    it('should throw an error if the file is not correct', () => {
-      const file = {}
-
-      expect(() => fileModel.splitFilename(file)).toThrow()
-    })
-    it('should return only the folder name if its a folder', () => {
-      const file = {
-        name: 'foo',
-        type: 'directory'
-      }
-      const result = fileModel.splitFilename(file)
-      expect(result).toEqual({
-        filename: 'foo',
-        extension: ''
-      })
-    })
-  })
-
   describe('generateNewFileNameOnConflict', () => {
     it('should generate the right file name with _X', () => {
       const filename1 = fileModel.generateNewFileNameOnConflict('test')
@@ -663,6 +655,53 @@ describe('File Model', () => {
       })
     })
   })
+
+  describe('isPlainText', () => {
+    describe('using mime types', () => {
+      it('should match mime types starting with "text/"', () => {
+        expect(fileModel.isPlainText('text/plain')).toBe(true)
+        expect(fileModel.isPlainText('text/markdown')).toBe(true)
+        expect(fileModel.isPlainText('application/text')).toBe(false)
+        expect(fileModel.isPlainText('something/text/else')).toBe(false)
+        expect(fileModel.isPlainText('text/vnd.cozy.note+markdown')).toBe(true)
+      })
+
+      it('should not match complex text formats', () => {
+        expect(fileModel.isPlainText('application/msword')).toBe(false)
+        expect(
+          fileModel.isPlainText('application/vnd.oasis.opendocument.text')
+        ).toBe(false)
+        expect(
+          fileModel.isPlainText('application/x-iwork-pages-sffpages')
+        ).toBe(false)
+      })
+
+      it('should not use the filename if a mime type is present', () => {
+        expect(
+          fileModel.isPlainText('application/msword', 'iswearitstext.txt')
+        ).toBe(false)
+      })
+    })
+
+    describe('using file names', () => {
+      it('should match txt files', () => {
+        expect(fileModel.isPlainText(undefined, 'iswearitstext.txt')).toBe(true)
+      })
+
+      it('should match md files', () => {
+        expect(fileModel.isPlainText(undefined, 'markdown.md')).toBe(true)
+      })
+
+      it('should not match anything else', () => {
+        expect(fileModel.isPlainText(undefined, 'file.doc')).toBe(false)
+        expect(fileModel.isPlainText(undefined, 'file.docx')).toBe(false)
+        expect(fileModel.isPlainText(undefined, 'file.pages')).toBe(false)
+        expect(fileModel.isPlainText(undefined, 'file.odt')).toBe(false)
+        expect(fileModel.isPlainText(undefined, 'file.csv')).toBe(false)
+        expect(fileModel.isPlainText(undefined, 'file.vcf')).toBe(false)
+      })
+    })
+  })
 })
 
 describe('File qualification', () => {

package/dist/types.js

@@ -99,12 +99,32 @@ var _dsl = require("./queries/dsl");
  */
 
 /**
- * A reference to a document (special case of a relationship used between photos and albums)
+ * A reference to a document
+ *
+ * @typedef {object} ReferencedByRelationship
+ * @property {RelationshipParent} [parent]
+ * @property {ReferencedBy} [referenced_by]
+ */
+
+/**
+ * @typedef {object} RelationshipParent
+ * @property {{related: string}} links
+ * @property {Reference} [data]
+ */
+
+/**
+ * @typedef {object} ReferencedBy
+ * @property {{self: string}} links
+ * @property {Reference[]|null} data
+ */
+
+/**
+ * A reference to a document
  * https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.files/#references
  *
  * @typedef {object} Reference
- * @property {string} _id - id of the document
- * @property {string} _type - doctype of the document
+ * @property {string} id - id of the document
+ * @property {string} type - doctype of the document
  */
 
 /**
@@ -125,7 +145,8 @@ var _dsl = require("./queries/dsl");
  * @property {string} [_type] - Type of the document
  * @property {string} [_rev] - Current revision of the document
  * @property {boolean} [_deleted] - When the document has been deleted
- * @property {object} [relationships] - Relationships of the document
+ * @property {ReferencedByRelationship} [relationships] - Relationships of the document
+ * @property {Reference[]} [referenced_by] - referenced by of another document
  */
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "27.4.0",
+  "version": "27.6.2",
   "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.1.0",
+    "cozy-stack-client": "^27.6.1",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.13",
     "microee": "^0.0.6",
@@ -52,7 +52,7 @@
     "btoa": "^1.2.1",
     "cozy-logger": "1.7.0",
     "cozy-ui": "48.0.0",
-    "date-fns": "2.19.0",
+    "date-fns": "2.27.0",
     "jsdoc-plugin-intersection": "^1.0.4",
     "mockdate": "^2.0.2",
     "react": "16.14.0",
@@ -69,5 +69,5 @@
     "react-native-inappbrowser-reborn": "^3.5.1"
   },
   "sideEffects": false,
-  "gitHead": "1ab42dff2e9088f4a3daff29866ad7a22b093791"
+  "gitHead": "36962d75de2e47cbcb11fa13f05fd0445a3aa39d"
 }

package/types/__tests__/fixtures.d.ts

@@ -103,6 +103,7 @@ export namespace FILE_1 {
     export { _type_6 as _type };
     const label_6: string;
     export { label_6 as label };
+    export const name: string;
 }
 export namespace FILE_2 {
     const _id_7: number;

package/types/associations/helpers.d.ts

@@ -7,3 +7,10 @@ export function create(target: any, { name, type, doctype }: {
     type: any;
     doctype: any;
 }, accessors: any): any;
+export function isReferencedBy(file: IOCozyFile, referencedBy: Doctype): boolean;
+export function isReferencedById(file: IOCozyFile, referencedBy: Doctype, referencedId: string): boolean;
+export function getReferencedBy(file: IOCozyFile, referencedBy: Doctype): Reference[];
+export function getReferencedById(file: IOCozyFile, referencedBy: Doctype, referencedId: string): Reference[];
+import { IOCozyFile } from "../types";
+import { Doctype } from "../types";
+import { Reference } from "../types";

package/types/associations/index.d.ts

@@ -6,4 +6,4 @@ import HasOneInPlace from "./HasOneInPlace";
 import HasManyInPlace from "./HasManyInPlace";
 import HasManyTriggers from "./HasManyTriggers";
 export { Association, HasManyFiles, HasMany, HasOne, HasOneInPlace, HasManyInPlace, HasManyTriggers };
-export { resolveClass, create } from "./helpers";
+export { resolveClass, create, isReferencedBy, isReferencedById, getReferencedBy, getReferencedById } from "./helpers";

package/types/index.d.ts

@@ -18,6 +18,7 @@ import * as models from "./models";
 export { manifest, models };
 export { QueryDefinition, Q, Mutations, MutationTypes, getDoctypeFromOperation } from "./queries/dsl";
 export { Association, HasMany, HasOne, HasOneInPlace, HasManyInPlace, HasManyTriggers } from "./associations";
+export { isReferencedBy, isReferencedById, getReferencedBy, getReferencedById } from "./associations/helpers";
 export { dehydrate, generateWebLink } from "./helpers";
 export { cancelable, isQueryLoading, hasQueryBeenLoaded } from "./utils";
 export { queryConnect, queryConnectFlat, withClient } from "./hoc";

package/types/models/file.d.ts

@@ -57,6 +57,10 @@ export function generateFileNameForRevision(file: IOCozyFile, revision: object,
 export function uploadFileWithConflictStrategy(client: CozyClient, file: string | ArrayBuffer, options: FileUploadOptions): any;
 export function readMobileFile(fileURL: string): Promise<any>;
 export function doMobileUpload(client: CozyClient, fileURL: string, options: FileUploadOptions): Promise<any>;
+export function isPlainText(mimeType?: string, fileName?: string): boolean;
+export function hasQualifications(file: IOCozyFile): boolean;
+export function hasCertifications(file: IOCozyFile): boolean;
+export function isFromKonnector(file: IOCozyFile): boolean;
 export type FileUploadOptions = {
     /**
      * - The file name to upload

package/types/queries/referencedBy.d.ts

@@ -0,0 +1,7 @@
+export function isReferencedBy(file: IOCozyFile, referencedBy: Doctype): boolean;
+export function isReferencedById(file: IOCozyFile, referencedBy: Doctype, referencedId: string): boolean;
+export function getReferencedBy(file: IOCozyFile, referencedBy: Doctype): Reference[];
+export function getReferencedById(file: IOCozyFile, referencedBy: Doctype, referencedId: string): Reference[];
+import { IOCozyFile } from "../types";
+import { Doctype } from "../types";
+import { Reference } from "../types";

package/types/types.d.ts

@@ -74,18 +74,37 @@ export type FetchMoreAble = {
 };
 export type UseQueryReturnValue = QueryState & FetchMoreAble;
 /**
- * A reference to a document (special case of a relationship used between photos and albums)
+ * A reference to a document
+ */
+export type ReferencedByRelationship = {
+    parent?: RelationshipParent;
+    referenced_by?: ReferencedBy;
+};
+export type RelationshipParent = {
+    links: {
+        related: string;
+    };
+    data?: Reference;
+};
+export type ReferencedBy = {
+    links: {
+        self: string;
+    };
+    data: Reference[] | null;
+};
+/**
+ * A reference to a document
  * https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.files/#references
  */
 export type Reference = {
     /**
      * - id of the document
      */
-    _id: string;
+    id: string;
     /**
      * - doctype of the document
      */
-    _type: string;
+    type: string;
 };
 export type ReferenceMap = {
     [x: string]: Reference[];
@@ -122,7 +141,11 @@ export type CozyClientDocument = {
     /**
      * - Relationships of the document
      */
-    relationships?: object;
+    relationships?: ReferencedByRelationship;
+    /**
+     * - referenced by of another document
+     */
+    referenced_by?: Reference[];
 };
 /**
  * - An io.cozy.files document