cozy-client 44.1.0 → 45.0.0

package/dist/CozyClient.js

@@ -2703,7 +2703,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 = "44.1.0";
+CozyClient.version = "45.0.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/models/file.js

@@ -47,7 +47,7 @@ var FILENAME_WITH_EXTENSION_REGEX = /(.+)(\..*)$/;
  * Returns base filename and extension
  *
  * @param {import("../types").IOCozyFile} file An io.cozy.files
- * @returns {object}  {filename, extension}
+ * @returns {{filename: string, extension: string}}
  */
 
 var splitFilename = function splitFilename(file) {

package/dist/models/sharing.js

@@ -9,6 +9,8 @@ exports.getSharingLink = void 0;
 
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 
 var _const = require("../const");
@@ -17,25 +19,39 @@ var _CozyClient = _interopRequireDefault(require("../CozyClient"));
 
 var _helpers = require("../helpers");
 
+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; }
+
 /**
  * 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] -
+ * @param {object} options - Options
+ * @param {string} [options.ttl] - Time to live (bigduration format, e.g. "4Y3M2D1h30m15s")
+ * @param {string} [options.password] - To generate a password-protected link
  * @returns {Promise<string>} Shared link
  */
 var getSharingLink = /*#__PURE__*/function () {
-  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(client, filesIds, isFlatDomain) {
+  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(client, filesIds) {
     var _sharedLink$attribute, _sharedLink$attribute2;
 
-    var PERMS, _yield$client$save, sharedLink, webLink;
+    var _ref2,
+        ttl,
+        password,
+        PERMS,
+        _yield$client$save,
+        sharedLink,
+        webLink,
+        _args = arguments;
 
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) {
         switch (_context.prev = _context.next) {
           case 0:
-            PERMS = {
+            _ref2 = _args.length > 2 && _args[2] !== undefined ? _args[2] : {}, ttl = _ref2.ttl, password = _ref2.password;
+            PERMS = _objectSpread(_objectSpread({
               _type: _const.DOCTYPE_PERMISSIONS,
               permissions: {
                 files: {
@@ -44,11 +60,15 @@ var getSharingLink = /*#__PURE__*/function () {
                   verbs: ['GET']
                 }
               }
-            };
-            _context.next = 3;
+            }, ttl && {
+              ttl: ttl
+            }), password && {
+              password: password
+            });
+            _context.next = 4;
             return client.save(PERMS);
 
-          case 3:
+          case 4:
             _yield$client$save = _context.sent;
             sharedLink = _yield$client$save.data;
             webLink = (0, _helpers.generateWebLink)({
@@ -56,11 +76,11 @@ var getSharingLink = /*#__PURE__*/function () {
               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'
+              subDomainType: client.capabilities.flat_subdomains ? 'flat' : 'nested'
             });
             return _context.abrupt("return", webLink);
 
-          case 7:
+          case 8:
           case "end":
             return _context.stop();
         }
@@ -68,7 +88,7 @@ var getSharingLink = /*#__PURE__*/function () {
     }, _callee);
   }));
 
-  return function getSharingLink(_x, _x2, _x3) {
+  return function getSharingLink(_x, _x2) {
     return _ref.apply(this, arguments);
   };
 }();

package/dist/models/sharing.spec.js

@@ -2,17 +2,15 @@ import { getSharingLink } from './sharing'
 
 describe('getSharingLink', () => {
   const mockSharecode = { attributes: { shortcodes: { code: 'shortcode' } } }
-  const mockClient = {
+  const mockClient = ({ isFlatDomain = false } = {}) => ({
     save: jest.fn(() => ({ data: mockSharecode })),
-    getStackClient: jest.fn(() => ({ uri: 'http://cozy.cloud' }))
-  }
-  const mockFiles = [
-    { id: 'fileId01', name: 'File 01' },
-    { id: 'fileId02', name: 'File 02' }
-  ]
+    getStackClient: jest.fn(() => ({ uri: 'http://cozy.cloud' })),
+    capabilities: { flat_subdomains: isFlatDomain }
+  })
+  const mockFiles = ['fileId01', 'fileId02']
 
   it('should generate the right share link if "isFlatDomain" param is not defined', async () => {
-    const sharingLink = await getSharingLink(mockClient, mockFiles)
+    const sharingLink = await getSharingLink(mockClient(), mockFiles)
 
     expect(sharingLink).toBe(
       'http://drive.cozy.cloud/public?sharecode=shortcode#/'
@@ -20,11 +18,9 @@ describe('getSharingLink', () => {
   })
 
   it('should generate the right share link to a nested cozy', async () => {
-    const isFlatDomain = false
     const sharingLink = await getSharingLink(
-      mockClient,
-      mockFiles,
-      isFlatDomain
+      mockClient({ isFlatDomain: false }),
+      mockFiles
     )
 
     expect(sharingLink).toBe(
@@ -33,11 +29,9 @@ describe('getSharingLink', () => {
   })
 
   it('should generate the right share link to a flat cozy', async () => {
-    const isFlatDomain = true
     const sharingLink = await getSharingLink(
-      mockClient,
-      mockFiles,
-      isFlatDomain
+      mockClient({ isFlatDomain: true }),
+      mockFiles
     )
 
     expect(sharingLink).toBe(
@@ -46,8 +40,64 @@ describe('getSharingLink', () => {
   })
 
   it('should generate the right share link with an correct sharecode', async () => {
-    const sharingLink = await getSharingLink(mockClient, mockFiles)
+    const sharingLink = await getSharingLink(mockClient(), mockFiles)
 
     expect(sharingLink).toContain('sharecode=shortcode')
   })
+  it('should save called with the "ttl" param', async () => {
+    const mockSave = jest.fn().mockReturnValue({ data: mockSharecode })
+    const client = { ...mockClient(), save: mockSave }
+    await getSharingLink(client, mockFiles, {
+      ttl: '1d'
+    })
+
+    expect(mockSave).toBeCalledWith({
+      _type: 'io.cozy.permissions',
+      permissions: {
+        files: {
+          type: 'io.cozy.files',
+          values: ['fileId01', 'fileId02'],
+          verbs: ['GET']
+        }
+      },
+      ttl: '1d'
+    })
+  })
+
+  it('should save called with the "password" param', async () => {
+    const mockSave = jest.fn().mockReturnValue({ data: mockSharecode })
+    const client = { ...mockClient(), save: mockSave }
+    await getSharingLink(client, mockFiles, {
+      password: 'password'
+    })
+
+    expect(mockSave).toBeCalledWith({
+      _type: 'io.cozy.permissions',
+      permissions: {
+        files: {
+          type: 'io.cozy.files',
+          values: ['fileId01', 'fileId02'],
+          verbs: ['GET']
+        }
+      },
+      password: 'password'
+    })
+  })
+
+  it('should save called without the "ttl" or "password" params', async () => {
+    const mockSave = jest.fn().mockReturnValue({ data: mockSharecode })
+    const client = { ...mockClient(), save: mockSave }
+    await getSharingLink(client, mockFiles)
+
+    expect(mockSave).toBeCalledWith({
+      _type: 'io.cozy.permissions',
+      permissions: {
+        files: {
+          type: 'io.cozy.files',
+          values: ['fileId01', 'fileId02'],
+          verbs: ['GET']
+        }
+      }
+    })
+  })
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "44.1.0",
+  "version": "45.0.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": "^44.0.0",
+    "cozy-stack-client": "^45.0.0",
     "date-fns": "2.29.3",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.13",
@@ -75,5 +75,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "74be3146ea4706cf3c2d7a3b07c4ef1171e33df7"
+  "gitHead": "d3762d9c73e50e9df1524e1220e34f82eab011d3"
 }

package/types/models/file.d.ts

@@ -25,7 +25,10 @@ export function ensureFilePath(file: object, parent: object): object;
  */
 export function getParentFolderId(file: object): string | null;
 export const ALBUMS_DOCTYPE: "io.cozy.photos.albums";
-export function splitFilename(file: import("../types").IOCozyFile): object;
+export function splitFilename(file: import("../types").IOCozyFile): {
+    filename: string;
+    extension: string;
+};
 export function isFile(file: import("../types").IOCozyFile): boolean;
 export function isDirectory(file: import("../types").IOCozyFile): boolean;
 export function isNote(file: import("../types").IOCozyFile): boolean;

package/types/models/sharing.d.ts

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