cozy-pouch-link 58.1.0 → 58.2.0

package/dist/CozyPouchLink.js

@@ -121,6 +121,7 @@ var doNothing = function doNothing(operation) {
  * @property {number} [syncDebounceMaxDelayInMs] The maximum duration (in ms) the `startReplicationWithDebounce()` method can be delayed. Should be used only when periodicSync is false. Default is 10 minutes
  * @property {number} [replicationInterval] Milliseconds between periodic replications
  * @property {string[]} doctypes Doctypes to replicate
+ * @property {boolean} isReadOnly Whether or not the link is read-only and should forward any write operation
  * @property {Record<string, object>} doctypesReplicationOptions A mapping from doctypes to replication options. All pouch replication options can be used, as well as the "strategy" option that determines which way the replication is done (can be "sync", "fromRemote" or "toRemote")
  * @property {import('./types').LinkPlatform} platform Platform specific adapters and methods
  * @property {import('cozy-client/src/performances/types').PerformanceAPI} [performanceApi] - The performance API that can be used to measure performances
@@ -719,6 +720,10 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
   }, {
     key: "supportsOperation",
     value: function supportsOperation(operation) {
+      if (this.options.readOnly && operation.mutationType) {
+        return false;
+      }
+
       var impactedDoctype = (0, _cozyClient.getDoctypeFromOperation)(operation); // If the Pouch is configured only to replicate from the remote,
       // we don't want to apply the mutation on it, but to forward
       // to the next link
@@ -768,6 +773,7 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
                   break;
                 }
 
+                // The doctype is not locally synced and thus cannot be requested: forward to next link
                 if (process.env.NODE_ENV !== 'production') {
                   _logger.default.info("Tried to access local ".concat(doctype, " but Cozy Pouch is not synced yet. Forwarding the operation to next link"));
                 }
@@ -945,41 +951,52 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
                 _context9.prev = 3;
                 sanitizedDoc.cozyLocalOnly = true;
                 engine = this.getQueryEngineFromDoctype(doc._type);
+
+                if (engine.db) {
+                  _context9.next = 9;
+                  break;
+                }
+
+                _logger.default.warn("".concat(doc._id, " is not persisted: no database found for doctype: ").concat(doc._type));
+
+                return _context9.abrupt("return", null);
+
+              case 9:
                 pouch = this.getPouch(doc._type);
-                _context9.next = 9;
+                _context9.next = 12;
                 return (0, _helpers2.getExistingDocument)(engine, sanitizedDoc._id);
 
-              case 9:
+              case 12:
                 resp = _context9.sent;
 
                 if (!(!(resp !== null && resp !== void 0 && resp.data) || Object.keys(resp === null || resp === void 0 ? void 0 : resp.data).length < 1)) {
-                  _context9.next = 12;
+                  _context9.next = 15;
                   break;
                 }
 
                 return _context9.abrupt("return", pouch.put(sanitizedDoc));
 
-              case 12:
+              case 15:
                 oldDoc = (0, jsonapi.sanitizeJsonApi)(resp.data);
 
                 if (!(0, _helpers2.areDocsEqual)(oldDoc, sanitizedDoc)) {
-                  _context9.next = 15;
+                  _context9.next = 18;
                   break;
                 }
 
                 return _context9.abrupt("return");
 
-              case 15:
+              case 18:
                 sanitizedDoc._rev = oldDoc._rev;
-                _context9.next = 18;
+                _context9.next = 21;
                 return pouch.put(sanitizedDoc);
 
-              case 18:
-                _context9.next = 24;
+              case 21:
+                _context9.next = 27;
                 break;
 
-              case 20:
-                _context9.prev = 20;
+              case 23:
+                _context9.prev = 23;
                 _context9.t0 = _context9["catch"](3);
 
                 _logger.default.error("PersistCozyData failed: with ".concat(_context9.t0)); // Do nothing on catch, to avoid throwing a read query
@@ -987,18 +1004,18 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
 
                 return _context9.abrupt("return", null);
 
-              case 24:
+              case 27:
                 this.performanceApi.measure({
                   markName: markName,
                   category: 'CozyPouchLink'
                 });
 
-              case 25:
+              case 28:
               case "end":
                 return _context9.stop();
             }
           }
-        }, _callee9, this, [[3, 20]]);
+        }, _callee9, this, [[3, 23]]);
       }));
 
       function persistCozyData(_x9) {

package/dist/db/pouchdb/getDocs.js

@@ -15,6 +15,8 @@ var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"))
 
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 
+var _errors = require("../../errors");
+
 var _helpers = _interopRequireDefault(require("../../helpers"));
 
 var _jsonapi = require("../../jsonapi");
@@ -35,11 +37,32 @@ var getDocsAndNormalize = /*#__PURE__*/function () {
         switch (_context.prev = _context.next) {
           case 0:
             client = _ref.client, doctype = _ref.doctype, db = _ref.db, queryFunc = _ref.queryFunc, _ref$queryParams = _ref.queryParams, queryParams = _ref$queryParams === void 0 ? {} : _ref$queryParams, _ref$withRows = _ref.withRows, withRows = _ref$withRows === void 0 ? true : _ref$withRows;
-            _context.next = 3;
+            _context.prev = 1;
+            _context.next = 4;
             return getDocs(db, queryFunc, queryParams);
 
-          case 3:
+          case 4:
             results = _context.sent;
+            _context.next = 14;
+            break;
+
+          case 7:
+            _context.prev = 7;
+            _context.t0 = _context["catch"](1);
+
+            if (!(0, _errors.isDocumentNotFoundPouchDBError)(_context.t0)) {
+              _context.next = 13;
+              break;
+            }
+
+            results = [];
+            _context.next = 14;
+            break;
+
+          case 13:
+            throw _context.t0;
+
+          case 14:
             jsonResult = (0, _jsonapi.fromPouchResult)({
               res: results,
               withRows: withRows,
@@ -48,12 +71,12 @@ var getDocsAndNormalize = /*#__PURE__*/function () {
             });
             return _context.abrupt("return", jsonResult);
 
-          case 6:
+          case 16:
           case "end":
             return _context.stop();
         }
       }
-    }, _callee);
+    }, _callee, null, [[1, 7]]);
   }));
 
   return function getDocsAndNormalize(_x) {

package/dist/errors.js

@@ -3,13 +3,14 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.isMissingPouchDBIndexError = exports.isMissingSQLiteIndexError = exports.isExpiredTokenError = void 0;
+exports.isDocumentNotFoundPouchDBError = exports.isMissingPouchDBIndexError = exports.isMissingSQLiteIndexError = exports.isExpiredTokenError = void 0;
 var EXPIRED_TOKEN_ERROR = /Expired token/;
 var INVALID_TOKEN_ERROR = /Invalid JWT token/;
 var INVALID_TOKEN_ALT_ERROR = /Invalid token/;
 var SQLITE_MISSING_INDEX_ERROR = /no such index/;
 var POUCHDB_MISSING_INDEX_ERROR = /Could not find that index/;
 var POUCHDB_MISSING_INDEX_ERROR_ALT = /no index/;
+var POUCHDB_NOT_FOUND_ERROR = /not_found/;
 
 var expiredTokenError = function expiredTokenError(error) {
   var errorMsg = error.message;
@@ -41,4 +42,10 @@ var isMissingPouchDBIndexError = function isMissingPouchDBIndexError(error) {
   return POUCHDB_MISSING_INDEX_ERROR.test(error.message) || POUCHDB_MISSING_INDEX_ERROR_ALT.test(error.message);
 };
 
-exports.isMissingPouchDBIndexError = isMissingPouchDBIndexError;
+exports.isMissingPouchDBIndexError = isMissingPouchDBIndexError;
+
+var isDocumentNotFoundPouchDBError = function isDocumentNotFoundPouchDBError(error) {
+  return POUCHDB_NOT_FOUND_ERROR.test(error.name);
+};
+
+exports.isDocumentNotFoundPouchDBError = isDocumentNotFoundPouchDBError;

package/dist/files.js

@@ -1 +1,51 @@
-"use strict";
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.queryFileById = exports.TYPE_FILE = exports.TYPE_DIRECTORY = void 0;
+
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+
+var _cozyClient = require("cozy-client");
+
+var defaultFetchPolicy = _cozyClient.fetchPolicies.olderThan(5 * 60 * 1000); // 5 min
+
+
+var TYPE_DIRECTORY = 'directory';
+exports.TYPE_DIRECTORY = TYPE_DIRECTORY;
+var TYPE_FILE = 'file';
+exports.TYPE_FILE = TYPE_FILE;
+
+var queryFileById = /*#__PURE__*/function () {
+  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(client, id) {
+    var queryOpts;
+    return _regenerator.default.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            queryOpts = {
+              as: "io.cozy.files/".concat(id),
+              fetchPolicy: defaultFetchPolicy,
+              singleDocData: true
+            };
+            return _context.abrupt("return", client.query((0, _cozyClient.Q)('io.cozy.files').getById(id), queryOpts));
+
+          case 2:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee);
+  }));
+
+  return function queryFileById(_x, _x2) {
+    return _ref.apply(this, arguments);
+  };
+}();
+
+exports.queryFileById = queryFileById;

package/dist/jsonapi.js

@@ -7,7 +7,11 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.sanitizeJsonApi = exports.sanitized = exports.fromPouchResult = exports.normalizeDoc = exports.normalizeDocs = void 0;
+exports.sanitizeJsonApi = exports.sanitized = exports.fromPouchResult = exports.computeFileFullpath = exports.normalizeDoc = exports.normalizeDocs = exports.resetAllPaths = exports.getFilePath = void 0;
+
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
@@ -19,10 +23,34 @@ var _startsWith = _interopRequireDefault(require("lodash/startsWith"));
 
 var _helpers = require("./db/helpers");
 
+var _files = require("./files");
+
+var _logger = _interopRequireDefault(require("./logger"));
+
 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; }
 
+/**
+ * The paths are not stored in CouchDB for files, thus there are not in PouchDB neither.
+ * So we keep all the file paths in memory to be able to quickly retrieve them
+ * at search time.
+ */
+var allPaths = new Map();
+
+var getFilePath = function getFilePath(id) {
+  return id ? allPaths.get(id) : undefined;
+};
+
+exports.getFilePath = getFilePath;
+
+var setFilePath = function setFilePath(id, path) {
+  allPaths.set(id, path);
+};
+
+var resetAllPaths = function resetAllPaths() {
+  allPaths.clear();
+};
 /**
  * Normalize several PouchDB document
  *
@@ -30,6 +58,10 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
  * @param {string} doctype - The document's doctype
  * @param {Array<import('./CozyPouchLink').CozyPouchDocument>} docs - The documents to normalize
  */
+
+
+exports.resetAllPaths = resetAllPaths;
+
 var normalizeDocs = function normalizeDocs(client, doctype, docs) {
   for (var i = docs.length; i >= 0; i--) {
     var doc = docs[i];
@@ -39,7 +71,7 @@ var normalizeDocs = function normalizeDocs(client, doctype, docs) {
       continue;
     }
 
-    if ((0, _startsWith.default)(doc.id, '_design/')) {
+    if ((0, _startsWith.default)(doc._id, '_design/')) {
       docs.splice(i, 1);
       continue;
     }
@@ -85,6 +117,10 @@ var normalizeDoc = function normalizeDoc(client, doctype, doc) {
   if (doctype === 'io.cozy.apps') {
     normalizeAppsLinks(client, doctype, doc);
   }
+
+  if (doctype === 'io.cozy.files') {
+    computeFileFullpath(client, doc);
+  }
 };
 
 exports.normalizeDoc = normalizeDoc;
@@ -109,11 +145,135 @@ var normalizeAppsLinks = function normalizeAppsLinks(client, doctype, docRef) {
   };
 };
 
-var fromPouchResult = function fromPouchResult(_ref) {
-  var res = _ref.res,
-      withRows = _ref.withRows,
-      doctype = _ref.doctype,
-      client = _ref.client;
+var buildPathWithName = function buildPathWithName(parentPath, fileName) {
+  var hasTrailingSlash = parentPath.substr(-1) === '/';
+  var path = hasTrailingSlash ? "".concat(parentPath).concat(fileName) : "".concat(parentPath, "/").concat(fileName);
+  return path;
+};
+/**
+ * Compute paths for files
+ *
+ * There are several ways to get a path:
+ *   - It is already defined in the file
+ *   - The file path exists in memory
+ *   - The directory path exists in memory
+ *   - The directory path is retrieved from db
+ *
+ * @param { CozyClient} client - The cozy client instance
+ * @param { import('cozy-client/types/types').IOCozyFile} file - The file to compute path
+ * @returns {Promise<import('cozy-client/types/types').IOCozyFile>} the completed file with path
+ */
+
+
+var computeFileFullpath = /*#__PURE__*/function () {
+  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(client, file) {
+    var _file$path, newPath, filePath, parentPath, path, parentDir, _path;
+
+    return _regenerator.default.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            if (!(file.type === _files.TYPE_DIRECTORY)) {
+              _context.next = 2;
+              break;
+            }
+
+            return _context.abrupt("return", file);
+
+          case 2:
+            if (!file.path) {
+              _context.next = 10;
+              break;
+            }
+
+            if (!((_file$path = file.path) !== null && _file$path !== void 0 && _file$path.includes(file.name))) {
+              _context.next = 6;
+              break;
+            }
+
+            setFilePath(file._id, file.path);
+            return _context.abrupt("return", file);
+
+          case 6:
+            newPath = buildPathWithName(file.path, file.name);
+            setFilePath(file._id, newPath);
+            file.path = newPath;
+            return _context.abrupt("return", file);
+
+          case 10:
+            filePath = getFilePath(file._id);
+
+            if (!filePath) {
+              _context.next = 14;
+              break;
+            }
+
+            // File path exists in memory
+            file.path = filePath;
+            return _context.abrupt("return", file);
+
+          case 14:
+            parentPath = getFilePath(file.dir_id);
+
+            if (!parentPath) {
+              _context.next = 20;
+              break;
+            }
+
+            // Parent path exists in memory
+            path = buildPathWithName(parentPath, file.name);
+            setFilePath(file._id, path); // Add the path in memory
+
+            file.path = path;
+            return _context.abrupt("return", file);
+
+          case 20:
+            if (file.dir_id) {
+              _context.next = 23;
+              break;
+            }
+
+            _logger.default.warn("Missing dir_id for file ".concat(file._id));
+
+            return _context.abrupt("return", file);
+
+          case 23:
+            _context.next = 25;
+            return (0, _files.queryFileById)(client, file.dir_id);
+
+          case 25:
+            parentDir = _context.sent;
+
+            if (parentDir !== null && parentDir !== void 0 && parentDir.path) {
+              _path = buildPathWithName(parentDir === null || parentDir === void 0 ? void 0 : parentDir.path, file.name);
+              file.path = _path; // Add the paths in memory
+
+              setFilePath(file.dir_id, parentDir.path);
+              setFilePath(file._id, _path);
+            }
+
+            return _context.abrupt("return", file);
+
+          case 28:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee);
+  }));
+
+  return function computeFileFullpath(_x, _x2) {
+    return _ref.apply(this, arguments);
+  };
+}();
+
+exports.computeFileFullpath = computeFileFullpath;
+
+var fromPouchResult = function fromPouchResult(_ref2) {
+  var res = _ref2.res,
+      withRows = _ref2.withRows,
+      doctype = _ref2.doctype,
+      client = _ref2.client;
 
   if (!res) {
     return null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-pouch-link",
-  "version": "58.1.0",
+  "version": "58.2.0",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "types/index.d.ts",
@@ -13,7 +13,7 @@
     "url": "git+https://github.com/cozy/cozy-client.git"
   },
   "dependencies": {
-    "cozy-client": "^58.1.0",
+    "cozy-client": "^58.2.0",
     "pouchdb-browser": "^7.2.2",
     "pouchdb-find": "^7.2.2"
   },
@@ -41,5 +41,5 @@
     "typecheck": "tsc -p tsconfig.json"
   },
   "sideEffects": false,
-  "gitHead": "e47b44f14cac28454265ceea790e0d7cb78dfc5a"
+  "gitHead": "3a6e5104325605d3d9c74ae5a1738e16289b659d"
 }

package/types/CozyPouchLink.d.ts

@@ -27,6 +27,10 @@ export type PouchLinkOptions = {
      * Doctypes to replicate
      */
     doctypes: string[];
+    /**
+     * Whether or not the link is read-only and should forward any write operation
+     */
+    isReadOnly: boolean;
     /**
      * A mapping from doctypes to replication options. All pouch replication options can be used, as well as the "strategy" option that determines which way the replication is done (can be "sync", "fromRemote" or "toRemote")
      */
@@ -52,6 +56,7 @@ export type PouchLinkOptions = {
  * @property {number} [syncDebounceMaxDelayInMs] The maximum duration (in ms) the `startReplicationWithDebounce()` method can be delayed. Should be used only when periodicSync is false. Default is 10 minutes
  * @property {number} [replicationInterval] Milliseconds between periodic replications
  * @property {string[]} doctypes Doctypes to replicate
+ * @property {boolean} isReadOnly Whether or not the link is read-only and should forward any write operation
  * @property {Record<string, object>} doctypesReplicationOptions A mapping from doctypes to replication options. All pouch replication options can be used, as well as the "strategy" option that determines which way the replication is done (can be "sync", "fromRemote" or "toRemote")
  * @property {import('./types').LinkPlatform} platform Platform specific adapters and methods
  * @property {import('cozy-client/src/performances/types').PerformanceAPI} [performanceApi] - The performance API that can be used to measure performances

package/types/errors.d.ts

@@ -1,3 +1,4 @@
 export function isExpiredTokenError(error: any): any;
 export function isMissingSQLiteIndexError(error: any): boolean;
 export function isMissingPouchDBIndexError(error: any): boolean;
+export function isDocumentNotFoundPouchDBError(error: any): boolean;

package/types/files.d.ts

@@ -0,0 +1,3 @@
+export const TYPE_DIRECTORY: "directory";
+export const TYPE_FILE: "file";
+export function queryFileById(client: any, id: any): Promise<any>;

package/types/jsonapi.d.ts

@@ -1,5 +1,8 @@
+export function getFilePath(id: any): any;
+export function resetAllPaths(): void;
 export function normalizeDocs(client: CozyClient, doctype: string, docs: Array<import('./CozyPouchLink').CozyPouchDocument>): void;
 export function normalizeDoc(client: CozyClient, doctype: string, doc: import('./CozyPouchLink').CozyPouchDocument): void;
+export function computeFileFullpath(client: CozyClient, file: import('cozy-client/types/types').IOCozyFile): Promise<import('cozy-client/types/types').IOCozyFile>;
 export function fromPouchResult({ res, withRows, doctype, client }: {
     res: any;
     withRows: any;