cozy-client 27.5.1 → 27.6.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [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)
 
 

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.5.1";
+CozyClient.version = "27.6.0";
 
 _microee.default.mixin(CozyClient);
 

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"));
 
@@ -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,34 +230,19 @@ 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({ name: null })).toThrow()
@@ -510,48 +542,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 +653,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "27.5.1",
+  "version": "27.6.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -69,5 +69,5 @@
     "react-native-inappbrowser-reborn": "^3.5.1"
   },
   "sideEffects": false,
-  "gitHead": "00cb31ac870bd50ea31a8df012a5387b95525a88"
+  "gitHead": "4228ec1287e3b18892f2e57128a09a77e87cae2e"
 }

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