cozy-client 52.1.0 → 52.2.0

package/dist/CozyClient.js

@@ -3049,7 +3049,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 = "52.1.0";
+CozyClient.version = "52.2.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/models/konnectorFolder.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.findKonnectorAccountFolderByReference = exports.buildFolderPermission = exports.buildFolderPath = exports.statDirectoryByPath = exports.createDirectoryByPath = exports.ensureKonnectorFolder = void 0;
+exports.findKonnectorAccountFolderByReference = exports.buildFolderPermission = exports.buildMainFolderPath = exports.buildFolderPath = exports.statDirectoryByPath = exports.createDirectoryByPath = exports.ensureKonnectorFolder = void 0;
 
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
@@ -35,13 +35,13 @@ var DEFAULT_LOCALIZED_BASE_DIR = 'Administrative';
  * @param {Object} options - options object
  * @param {import('../types').IOCozyKonnector} options.konnector - io.cozy.konnectors document
  * @param {import('../types').IOCozyAccount} options.account - io.cozy.accounts document
- * @param {String} options.lang - instance current language. ex: 'fr'
+ * @param {string} options.lang - instance current language. ex: 'fr'
  * @returns {Promise<import('../types').IOCozyFolder>}
  */
 
 var ensureKonnectorFolder = /*#__PURE__*/function () {
   var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(client, _ref) {
-    var konnector, account, lang, permissions, fileCollection, t, _yield$Promise$all, _yield$Promise$all2, adminFolder, photosFolder, sourceAccountIdentifier, alreadyExistingAccountFolder, alreadyExistingKonnectorMainFolder, path, folder, _yield$fileCollection, konnectorFolder;
+    var konnector, account, lang, permissions, t, _yield$Promise$all, _yield$Promise$all2, adminFolder, photosFolder, sourceAccountIdentifier, alreadyExistingAccountFolder, alreadyExistingKonnectorMainFolder, mainPath, mainFolder, path, folder;
 
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) {
@@ -49,50 +49,49 @@ var ensureKonnectorFolder = /*#__PURE__*/function () {
           case 0:
             konnector = _ref.konnector, account = _ref.account, lang = _ref.lang;
             permissions = client.collection(PERMISSIONS_DOCTYPE);
-            fileCollection = client.collection(FILES_DOCTYPE);
             t = (0, _locales.getLocalizer)(lang);
-            _context.next = 6;
+            _context.next = 5;
             return Promise.all([(0, _folder.ensureMagicFolder)(client, _folder.MAGIC_FOLDERS.ADMINISTRATIVE, t('MagicFolders.administrative')), (0, _folder.ensureMagicFolder)(client, _folder.MAGIC_FOLDERS.PHOTOS, t('MagicFolders.photos'))]);
 
-          case 6:
+          case 5:
             _yield$Promise$all = _context.sent;
             _yield$Promise$all2 = (0, _slicedToArray2.default)(_yield$Promise$all, 2);
             adminFolder = _yield$Promise$all2[0];
             photosFolder = _yield$Promise$all2[1];
             sourceAccountIdentifier = (0, _account.getAccountName)(account);
-            _context.next = 13;
+            _context.next = 12;
             return findKonnectorAccountFolderByReference({
               client: client,
               slug: konnector.slug,
               sourceAccountIdentifier: sourceAccountIdentifier
             });
 
-          case 13:
+          case 12:
             alreadyExistingAccountFolder = _context.sent;
 
             if (!alreadyExistingAccountFolder) {
-              _context.next = 16;
+              _context.next = 15;
               break;
             }
 
             return _context.abrupt("return", alreadyExistingAccountFolder);
 
-          case 16:
-            _context.next = 18;
+          case 15:
+            _context.next = 17;
             return findKonnectorMainFolderByReference({
               client: client,
               slug: konnector.slug
             });
 
-          case 18:
+          case 17:
             alreadyExistingKonnectorMainFolder = _context.sent;
 
             if (!alreadyExistingKonnectorMainFolder) {
-              _context.next = 23;
+              _context.next = 22;
               break;
             }
 
-            _context.next = 22;
+            _context.next = 21;
             return saveKonnectorAccountFolder({
               client: client,
               mainFolder: alreadyExistingKonnectorMainFolder,
@@ -100,41 +99,63 @@ var ensureKonnectorFolder = /*#__PURE__*/function () {
               sourceAccountIdentifier: sourceAccountIdentifier
             });
 
-          case 22:
+          case 21:
             return _context.abrupt("return", _context.sent);
 
-          case 23:
-            // if the previous shortcuts did not work, create the folders like we did before but with proper references
-            path = buildFolderPath(konnector, account, {
+          case 22:
+            mainPath = buildMainFolderPath(konnector, {
               administrative: adminFolder.path,
               photos: photosFolder.path
             });
-            _context.next = 26;
-            return statDirectoryByPath(client, path);
+            _context.next = 25;
+            return statDirectoryByPath(client, mainPath);
 
-          case 26:
+          case 25:
             _context.t0 = _context.sent;
 
             if (_context.t0) {
-              _context.next = 31;
+              _context.next = 30;
               break;
             }
 
-            _context.next = 30;
-            return createDirectoryByPath(client, path);
+            _context.next = 29;
+            return createDirectoryByPath(client, mainPath);
 
-          case 30:
+          case 29:
             _context.t0 = _context.sent;
 
-          case 31:
-            folder = _context.t0;
-            _context.next = 34;
-            return fileCollection.statById(folder.dir_id);
+          case 30:
+            mainFolder = _context.t0;
+            ensureKonnectorReference({
+              client: client,
+              folder: mainFolder,
+              konnector: konnector
+            }); // if the previous shortcuts did not work, create the folders like we did before but with proper references
+
+            path = buildFolderPath(konnector, account, {
+              administrative: adminFolder.path,
+              photos: photosFolder.path
+            });
+            _context.next = 35;
+            return statDirectoryByPath(client, path);
+
+          case 35:
+            _context.t1 = _context.sent;
+
+            if (_context.t1) {
+              _context.next = 40;
+              break;
+            }
+
+            _context.next = 39;
+            return createDirectoryByPath(client, path);
+
+          case 39:
+            _context.t1 = _context.sent;
 
-          case 34:
-            _yield$fileCollection = _context.sent;
-            konnectorFolder = _yield$fileCollection.data;
-            _context.next = 38;
+          case 40:
+            folder = _context.t1;
+            _context.next = 43;
             return Promise.all([permissions.add(konnector, buildFolderPermission(folder)), ensureKonnectorReference({
               client: client,
               folder: folder,
@@ -143,16 +164,12 @@ var ensureKonnectorFolder = /*#__PURE__*/function () {
               client: client,
               folder: folder,
               sourceAccountIdentifier: sourceAccountIdentifier
-            }), ensureKonnectorReference({
-              client: client,
-              folder: konnectorFolder,
-              konnector: konnector
             })]);
 
-          case 38:
+          case 43:
             return _context.abrupt("return", folder);
 
-          case 39:
+          case 44:
           case "end":
             return _context.stop();
         }
@@ -286,7 +303,7 @@ var statDirectoryByPath = /*#__PURE__*/function () {
  * @param  {Object<string, string>} magicFolders   Object containing a mapping from folder
  * identifiers (ex: $administrative) to their localized values (ex:
  * Administratif).
- * @returns {String}           The result path
+ * @returns {string}           The result path
  */
 
 
@@ -321,15 +338,63 @@ var buildFolderPath = function buildFolderPath(konnector, account) {
   });
   return "/".concat(renderedBaseDir, "/").concat(renderedPath);
 };
+/**
+ * Build konnector main folder path for a given konnector.
+ *
+ * If konnector.folders[0].defaultDir exists, it is used as default directory.
+ *
+ * Occurrences of following strings in base directory are replaced by:
+ * * `$administrative`: Administrative folder
+ * * `$photos`: Photos folder
+ *
+ * Occurrences of following strings in path are replaced by:
+ * * `$konnector`: Konnector name
+ *
+ * If no konnectors.folders[0].defaultDir is set, the default dir used is
+ * *  `$administrative/$konnector`
+ *
+ * @param  {import('../types').IOCozyKonnector} konnector - Konnector document
+ * @param  {Object<string, string>} magicFolders - Object containing a mapping from folder identifiers (ex: $administrative) to their localized values (ex: Administratif).
+ * @returns {string}           The result path
+ */
+
+
+exports.buildFolderPath = buildFolderPath;
+
+var buildMainFolderPath = function buildMainFolderPath(konnector) {
+  var _konnector$folders2, _konnector$folders2$, _konnector$folders2$$, _konnector$folders2$$2, _konnector$folders2$$3;
+
+  var magicFolders = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  var fullPath = (konnector === null || konnector === void 0 ? void 0 : (_konnector$folders2 = konnector.folders) === null || _konnector$folders2 === void 0 ? void 0 : (_konnector$folders2$ = _konnector$folders2[0]) === null || _konnector$folders2$ === void 0 ? void 0 : (_konnector$folders2$$ = _konnector$folders2$.defaultDir) === null || _konnector$folders2$$ === void 0 ? void 0 : (_konnector$folders2$$2 = _konnector$folders2$$.split('/')) === null || _konnector$folders2$$2 === void 0 ? void 0 : (_konnector$folders2$$3 = _konnector$folders2$$2.slice(0, -1)) === null || _konnector$folders2$$3 === void 0 ? void 0 : _konnector$folders2$$3.join('/')) || '$administrative/$konnector';
+  var sanitizedPath = trim(fullPath.replace(/(\/+)/g, '/'), '/');
+
+  if (!hasBaseDir(sanitizedPath)) {
+    sanitizedPath = '$administrative/' + sanitizedPath;
+  }
+  /**
+   * Now that we have our sanitizedPath, we can split it in two strings
+   * * `baseDir` containing the baseDir path
+   * * `buildedSubDir` containing the rest of the path (ie the path without baseDir)
+   */
+
+
+  var baseDir = sanitizedPath.split('/', 1);
+  var buildedSubDir = buildSubDir(sanitizedPath, baseDir[0]);
+  var renderedBaseDir = renderBaseDir(baseDir[0], magicFolders);
+  var renderedPath = renderSubDir(buildedSubDir, {
+    konnector: konnector.name
+  });
+  return "/".concat(renderedBaseDir, "/").concat(renderedPath);
+};
 /**
  * Check if the provided Path start withs our allowedBaseDirPath to see
  *
- * @param {String} path - path to test
+ * @param {string} path - path to test
  * @returns {Boolean}
  */
 
 
-exports.buildFolderPath = buildFolderPath;
+exports.buildMainFolderPath = buildMainFolderPath;
 
 var hasBaseDir = function hasBaseDir(path) {
   return allowedBaseDirVariables.some(function (baseDirVar) {
@@ -348,9 +413,9 @@ var allowedBaseDirVariables = ['$administrative', '$photos'];
  * This method creates the subDir. We can't have an empty subDir, so we set
  * it to our default '$konnector/$account'
  *
- * @param {String} fullPath String containing potentially the defaultDir
- * @param {String} defaultDir String to remove from the fullPath
- * @returns {String}
+ * @param {string} fullPath String containing potentially the defaultDir
+ * @param {string} defaultDir String to remove from the fullPath
+ * @returns {string}
  */
 
 var buildSubDir = function buildSubDir(fullPath, defaultDir) {
@@ -367,11 +432,11 @@ var buildSubDir = function buildSubDir(fullPath, defaultDir) {
  * For example, it will render `$administrative` with the given value passed in
  * folders object. We expect to find in folders a localized value.
  *
- * @param  {String} baseDir base directory variable, expects `$administrative`
+ * @param  {string} baseDir base directory variable, expects `$administrative`
  * or `$photos`
  * @param  {Object<string, string>} magicFolders Object indexing base directory variable with
  * corresponding localized name.
- * @returns {String}         Localized directory
+ * @returns {string}         Localized directory
  */
 
 
@@ -387,11 +452,11 @@ var renderBaseDir = function renderBaseDir(baseDir) {
  * Available variable are `$konnector` (konnector name) and `$account`
  * (account label, i.e. id or name)
  *
- * @param  {String} path      Path to render : ex '/Administratif/$konnector/$account'
+ * @param  {string} path      Path to render : ex '/Administratif/$konnector/$account'
  * @param  {Object} variables Object mapping variable to actual values
  * @param  {import('../types').IOCozyKonnector['name']} variables.konnector - konnector name
- * @param  {String} variables.account - account name
- * @returns {String}           Rendered path
+ * @param  {string} [variables.account] - account name
+ * @returns {string}           Rendered path
  */
 
 
@@ -428,9 +493,9 @@ var buildFolderPermission = function buildFolderPermission(folder) {
 /**
  * Replacer of the lodash/trim function
  *
- * @param {String} str - Input string
- * @param {String} c - String to trim from the input string
- * @returns {String}
+ * @param {string} str - Input string
+ * @param {string} c - String to trim from the input string
+ * @returns {string}
  */
 
 

package/dist/models/konnectorFolder.spec.js

@@ -44,7 +44,7 @@ describe('ensureKonnectorFolder', () => {
     mockClient.query.mockResolvedValue({
       included: []
     })
-    mockClient.statByPath.mockRejectedValueOnce({ status: 404 })
+    mockClient.statByPath.mockRejectedValue({ status: 404 })
     mockClient.statById.mockResolvedValueOnce({
       data: { _id: 'parentfolderid' }
     })
@@ -54,6 +54,12 @@ describe('ensureKonnectorFolder', () => {
         dir_id: 'parentfolderid'
       }
     })
+    mockClient.createDirectoryByPath.mockResolvedValueOnce({
+      data: {
+        _id: 'createdfolderid',
+        dir_id: 'parentfolderid'
+      }
+    })
     const result = await ensureKonnectorFolder(mockClient, {
       konnector,
       account,
@@ -220,6 +226,12 @@ describe('ensureKonnectorFolder', () => {
         dir_id: 'parentfolderid'
       }
     })
+    mockClient.statByPath.mockResolvedValueOnce({
+      data: {
+        _id: 'alreadyexistingfolderid',
+        dir_id: 'parentfolderid'
+      }
+    })
     const result = await ensureKonnectorFolder(mockClient, {
       konnector: {
         name: 'konnectorName',
@@ -251,6 +263,12 @@ describe('ensureKonnectorFolder', () => {
         trashed: true
       }
     })
+    mockClient.statByPath.mockResolvedValueOnce({
+      data: {
+        _id: 'folderintrash',
+        trashed: true
+      }
+    })
     mockClient.statById.mockResolvedValueOnce({
       data: {
         _id: 'parentfolderid'
@@ -262,6 +280,12 @@ describe('ensureKonnectorFolder', () => {
         dir_id: 'parentfolderid'
       }
     })
+    mockClient.createDirectoryByPath.mockResolvedValueOnce({
+      data: {
+        _id: 'createdfolderid',
+        dir_id: 'parentfolderid'
+      }
+    })
     const result = await ensureKonnectorFolder(mockClient, {
       konnector,
       account,
@@ -288,4 +312,96 @@ describe('ensureKonnectorFolder', () => {
       { _id: 'createdfolderid', dir_id: 'parentfolderid' }
     ])
   })
+  it('should add proper references to konnector folder with proper name if any', async () => {
+    const existingKonnectorFolder = {
+      _id: 'konnectorFolderId',
+      path: '/Administratif/' + konnector.name,
+      type: 'directory',
+      referenced_by: []
+    }
+    const createdAccountFolder = {
+      _id: 'accountfolderid',
+      path: '/Administratif/' + konnector.name + '/testAccountName',
+      type: 'directory',
+      referenced_by: []
+    }
+    mockClient.query.mockResolvedValue({
+      included: []
+    })
+    mockClient.statByPath
+      .mockResolvedValueOnce({
+        data: existingKonnectorFolder
+      })
+      .mockResolvedValueOnce({ data: false })
+    mockClient.createDirectoryByPath.mockResolvedValueOnce({
+      data: createdAccountFolder
+    })
+
+    await ensureKonnectorFolder(mockClient, {
+      konnector,
+      account,
+      lang: 'fr'
+    })
+    expect(mockClient.addReferencesTo).toHaveBeenNthCalledWith(1, konnector, [
+      existingKonnectorFolder
+    ])
+    expect(mockClient.addReferencesTo).toHaveBeenNthCalledWith(2, konnector, [
+      createdAccountFolder
+    ])
+    expect(mockClient.addReferencesTo).toHaveBeenNthCalledWith(
+      3,
+      {
+        _id: 'testAccountName',
+        _type: 'io.cozy.accounts.sourceAccountIdentifier'
+      },
+      [createdAccountFolder]
+    )
+    expect(mockClient.addReferencesTo).toHaveBeenCalledTimes(3)
+  })
+
+  it('should add proper references to konnector folder even if account folder has konnector reference', async () => {
+    const existingKonnectorFolder = {
+      _id: 'konnectorFolderId',
+      path: '/Administratif/' + konnector.name,
+      type: 'directory',
+      referenced_by: []
+    }
+    const existingAccountFolder = {
+      _id: 'accountfolderid',
+      path: '/Administratif/' + konnector.name + '/testAccountName',
+      type: 'directory',
+      referenced_by: [
+        {
+          type: 'io.cozy.konnectors',
+          id: 'io.cozy.konnectors/konnectorSlug'
+        }
+      ]
+    }
+    mockClient.query.mockResolvedValue({
+      included: []
+    })
+    mockClient.statByPath
+      .mockResolvedValueOnce({
+        data: existingKonnectorFolder
+      })
+      .mockResolvedValueOnce({ data: existingAccountFolder })
+    await ensureKonnectorFolder(mockClient, {
+      konnector,
+      account,
+      lang: 'fr'
+    })
+    expect(mockClient.addReferencesTo).toHaveBeenCalledTimes(2)
+    expect(mockClient.addReferencesTo).toHaveBeenNthCalledWith(1, konnector, [
+      existingKonnectorFolder
+    ])
+    expect(mockClient.addReferencesTo).toHaveBeenNthCalledWith(
+      2,
+      {
+        _id: 'testAccountName',
+        _type: 'io.cozy.accounts.sourceAccountIdentifier'
+      },
+      [existingAccountFolder]
+    )
+    expect(mockClient.createDirectoryByPath).not.toHaveBeenCalled()
+  })
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "52.1.0",
+  "version": "52.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": "^52.0.0",
+    "cozy-stack-client": "^52.2.0",
     "date-fns": "2.29.3",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.13",
@@ -72,5 +72,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "c6762bb0c1fad4ac62f18b4118c8577a749caf2b"
+  "gitHead": "e1dadbc037bd2beda076f2c287bc485e2c50de80"
 }

package/types/models/konnectorFolder.d.ts

@@ -8,6 +8,9 @@ export function statDirectoryByPath(client: CozyClient, path: string): Promise<i
 export function buildFolderPath(konnector: import('../types').IOCozyKonnector, account: import('../types').IOCozyAccount, magicFolders?: {
     [x: string]: string;
 }): string;
+export function buildMainFolderPath(konnector: import('../types').IOCozyKonnector, magicFolders?: {
+    [x: string]: string;
+}): string;
 export function buildFolderPermission(folder: import('../types').IOCozyFolder): any;
 export function findKonnectorAccountFolderByReference({ client, slug, sourceAccountIdentifier }: {
     client: CozyClient;