cozy-client 28.0.2 → 28.2.0

package/dist/CozyClient.js

@@ -2537,7 +2537,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 = "28.0.2";
+CozyClient.version = "28.2.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/CozyClient.spec.js

@@ -1800,7 +1800,7 @@ describe('file creation', () => {
     expect(doc._id).toEqual('1337')
     expect(client.stackClient.fetchJSON).toHaveBeenCalledWith(
       'POST',
-      '/files/folder-id?Name=toto.pdf&Type=file&Executable=false&MetadataID=&Size=12',
+      '/files/folder-id?Name=toto.pdf&Type=file&Executable=false&Encrypted=false&MetadataID=&Size=12',
       'file-content',
       {
         headers: { 'Content-Type': 'text/plain', 'Content-Length': '12' },

package/dist/const.js

@@ -3,8 +3,10 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.DOCTYPE_FILES = exports.REGISTRATION_ABORT = void 0;
+exports.DOCTYPE_PERMISSIONS = exports.DOCTYPE_FILES = exports.REGISTRATION_ABORT = void 0;
 var REGISTRATION_ABORT = 'REGISTRATION_ABORT';
 exports.REGISTRATION_ABORT = REGISTRATION_ABORT;
 var DOCTYPE_FILES = 'io.cozy.files';
-exports.DOCTYPE_FILES = DOCTYPE_FILES;
+exports.DOCTYPE_FILES = DOCTYPE_FILES;
+var DOCTYPE_PERMISSIONS = 'io.cozy.permissions';
+exports.DOCTYPE_PERMISSIONS = DOCTYPE_PERMISSIONS;

package/dist/models/file.js

@@ -8,7 +8,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.normalize = normalize;
 exports.ensureFilePath = ensureFilePath;
 exports.getParentFolderId = getParentFolderId;
-exports.fetchBlobFileById = 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;
+exports.fetchBlobFileById = 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.isEncrypted = exports.isNote = exports.isDirectory = exports.isFile = exports.splitFilename = exports.ALBUMS_DOCTYPE = void 0;
 
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
@@ -109,6 +109,19 @@ var isNote = function isNote(file) {
   if (file && file.name && file.name.endsWith('.cozy-note') && file.type === FILE_TYPE && file.metadata && file.metadata.content !== undefined && file.metadata.schema !== undefined && file.metadata.title !== undefined && file.metadata.version !== undefined) return true;
   return false;
 };
+/**
+ * Whether the file is client-side encrypted
+ *
+ * @param {IOCozyFile} file - io.cozy.files document
+ * @returns {boolean}
+ */
+
+
+exports.isNote = isNote;
+
+var isEncrypted = function isEncrypted(file) {
+  return !!file.encrypted;
+};
 /**
  * Whether the file is supported by Only Office
  *
@@ -117,7 +130,7 @@ var isNote = function isNote(file) {
  */
 
 
-exports.isNote = isNote;
+exports.isEncrypted = isEncrypted;
 
 var isOnlyOfficeFile = function isOnlyOfficeFile(file) {
   return isFile(file) && !isNote(file) && (file.class === 'text' || file.class === 'spreadsheet' || file.class === 'slide');

package/dist/models/file.spec.js

@@ -231,6 +231,18 @@ describe('File Model', () => {
     })
   })
 
+  describe('encryption', () => {
+    it('should return when a file is encrypted or not', () => {
+      const encryptedFile = {
+        name: 'encryptedfile.txt',
+        encrypted: true
+      }
+      const plaintextFile = { name: 'plaintext.txt', mime: 'text' }
+      expect(fileModel.isEncrypted(encryptedFile)).toBe(true)
+      expect(fileModel.isEncrypted(plaintextFile)).toBe(false)
+    })
+  })
+
   describe('splitFilename', () => {
     it.each`
       opts                                       | result

package/dist/models/index.js

@@ -5,7 +5,7 @@ var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWild
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.timeseries = exports.document = exports.contact = exports.utils = exports.permission = exports.note = exports.account = exports.folder = exports.file = exports.applications = exports.instance = exports.trigger = exports.accounts = exports.triggers = void 0;
+exports.sharing = exports.timeseries = exports.document = exports.contact = exports.utils = exports.permission = exports.note = exports.account = exports.folder = exports.file = exports.applications = exports.instance = exports.trigger = exports.accounts = exports.triggers = void 0;
 
 var trigger = _interopRequireWildcard(require("./trigger"));
 
@@ -54,6 +54,10 @@ exports.document = document;
 var timeseries = _interopRequireWildcard(require("./timeseries"));
 
 exports.timeseries = timeseries;
+
+var sharing = _interopRequireWildcard(require("./sharing"));
+
+exports.sharing = sharing;
 // For backward compatibility before 9.0.0
 var triggers = trigger;
 exports.triggers = triggers;

package/dist/models/sharing.js

@@ -0,0 +1,76 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getSharingLink = void 0;
+
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+
+var _const = require("../const");
+
+var _CozyClient = _interopRequireDefault(require("../CozyClient"));
+
+var _helpers = require("../helpers");
+
+/**
+ * Generate Sharing link for one or many files
+ *
+ * @param {CozyClient} client - Instance of CozyClient
+ * @param {string[]} filesIds - Array of io.cozy.files ids
+ * @param {boolean} [isFlatDomain] -
+ * @returns {Promise<string>} Shared link
+ */
+var getSharingLink = /*#__PURE__*/function () {
+  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(client, filesIds, isFlatDomain) {
+    var _sharedLink$attribute, _sharedLink$attribute2;
+
+    var PERMS, _yield$client$save, sharedLink, webLink;
+
+    return _regenerator.default.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            PERMS = {
+              _type: _const.DOCTYPE_PERMISSIONS,
+              permissions: {
+                files: {
+                  type: _const.DOCTYPE_FILES,
+                  values: filesIds,
+                  verbs: ['GET']
+                }
+              }
+            };
+            _context.next = 3;
+            return client.save(PERMS);
+
+          case 3:
+            _yield$client$save = _context.sent;
+            sharedLink = _yield$client$save.data;
+            webLink = (0, _helpers.generateWebLink)({
+              cozyUrl: client.getStackClient().uri,
+              searchParams: [['sharecode', sharedLink === null || sharedLink === void 0 ? void 0 : (_sharedLink$attribute = sharedLink.attributes) === null || _sharedLink$attribute === void 0 ? void 0 : (_sharedLink$attribute2 = _sharedLink$attribute.shortcodes) === null || _sharedLink$attribute2 === void 0 ? void 0 : _sharedLink$attribute2.code]],
+              pathname: '/public',
+              slug: 'drive',
+              subDomainType: isFlatDomain ? 'flat' : 'nested'
+            });
+            return _context.abrupt("return", webLink);
+
+          case 7:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee);
+  }));
+
+  return function getSharingLink(_x, _x2, _x3) {
+    return _ref.apply(this, arguments);
+  };
+}();
+
+exports.getSharingLink = getSharingLink;

package/dist/models/sharing.spec.js

@@ -0,0 +1,53 @@
+import { getSharingLink } from './sharing'
+
+describe('getSharingLink', () => {
+  const mockSharecode = { attributes: { shortcodes: { code: 'shortcode' } } }
+  const mockClient = {
+    save: jest.fn(() => ({ data: mockSharecode })),
+    getStackClient: jest.fn(() => ({ uri: 'http://cozy.cloud' }))
+  }
+  const mockFiles = [
+    { id: 'fileId01', name: 'File 01' },
+    { id: 'fileId02', name: 'File 02' }
+  ]
+
+  it('should generate the right share link if "isFlatDomain" param is not defined', async () => {
+    const sharingLink = await getSharingLink(mockClient, mockFiles)
+
+    expect(sharingLink).toBe(
+      'http://drive.cozy.cloud/public?sharecode=shortcode#/'
+    )
+  })
+
+  it('should generate the right share link to a nested cozy', async () => {
+    const isFlatDomain = false
+    const sharingLink = await getSharingLink(
+      mockClient,
+      mockFiles,
+      isFlatDomain
+    )
+
+    expect(sharingLink).toBe(
+      'http://drive.cozy.cloud/public?sharecode=shortcode#/'
+    )
+  })
+
+  it('should generate the right share link to a flat cozy', async () => {
+    const isFlatDomain = true
+    const sharingLink = await getSharingLink(
+      mockClient,
+      mockFiles,
+      isFlatDomain
+    )
+
+    expect(sharingLink).toBe(
+      'http://cozy-drive.cloud/public?sharecode=shortcode#/'
+    )
+  })
+
+  it('should generate the right share link with an correct sharecode', async () => {
+    const sharingLink = await getSharingLink(mockClient, mockFiles)
+
+    expect(sharingLink).toContain('sharecode=shortcode')
+  })
+})

package/dist/types.js

@@ -165,8 +165,11 @@ var _dsl = require("./queries/dsl");
  * @property {FilesDoctype} _type - Doctype of the file
  * @property {string} name - Name of the file
  * @property {object} metadata - Metadata of the file
- * @property {object} type - Type of the file
- * @property {object} class - Class of the file
+ * @property {string} type - Type of the file
+ * @property {string} class - Class of the file
+ * @property {string} mime - Mime of the file
+ * @property {boolean} executable - Whether or not the file is executable
+ * @property {boolean} encrypted - Whether or not the file is client-side encrypted
  * @typedef {CozyClientDocument & FileDocument} IOCozyFile - An io.cozy.files document
  */
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "28.0.2",
+  "version": "28.2.0",
   "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": "^28.0.1",
+    "cozy-stack-client": "^28.2.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": "806a1dfa8abd8cf90306af37c32650b96e43583e"
+  "gitHead": "a39d0c43bb88a0b0c27f9071b40eb06072a553c0"
 }

package/types/const.d.ts

@@ -1,2 +1,3 @@
 export const REGISTRATION_ABORT: "REGISTRATION_ABORT";
 export const DOCTYPE_FILES: "io.cozy.files";
+export const DOCTYPE_PERMISSIONS: "io.cozy.permissions";

package/types/models/file.d.ts

@@ -29,6 +29,7 @@ export function splitFilename(file: IOCozyFile): object;
 export function isFile(file: IOCozyFile): boolean;
 export function isDirectory(file: IOCozyFile): boolean;
 export function isNote(file: IOCozyFile): boolean;
+export function isEncrypted(file: IOCozyFile): boolean;
 export function isOnlyOfficeFile(file: IOCozyFile): boolean;
 export function shouldBeOpenedByOnlyOffice(file: IOCozyFile): boolean;
 export function isShortcut(file: IOCozyFile): boolean;

package/types/models/index.d.ts

@@ -12,4 +12,5 @@ import * as utils from "./utils";
 import * as contact from "./contact";
 import * as document from "./document";
 import * as timeseries from "./timeseries";
-export { trigger, instance, applications, file, folder, note, account, permission, utils, contact, document, timeseries };
+import * as sharing from "./sharing";
+export { trigger, instance, applications, file, folder, note, account, permission, utils, contact, document, timeseries, sharing };

package/types/models/sharing.d.ts

@@ -0,0 +1,2 @@
+export function getSharingLink(client: CozyClient, filesIds: string[], isFlatDomain?: boolean): Promise<string>;
+import CozyClient from "../CozyClient";

package/types/types.d.ts

@@ -187,11 +187,23 @@ export type FileDocument = {
     /**
      * - Type of the file
      */
-    type: object;
+    type: string;
     /**
      * - Class of the file
      */
-    class: object;
+    class: string;
+    /**
+     * - Mime of the file
+     */
+    mime: string;
+    /**
+     * - Whether or not the file is executable
+     */
+    executable: boolean;
+    /**
+     * - Whether or not the file is client-side encrypted
+     */
+    encrypted: boolean;
 };
 /**
  * - An io.cozy.files document