cozy-pouch-link 57.5.0 → 57.6.0

package/dist/mango.js

@@ -5,7 +5,11 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getIndexFields = exports.getIndexNameFromFields = exports.makeKeyFromPartialFilter = void 0;
+exports.getIndexName = exports.getIndexFields = exports.findExistingIndex = exports.createIndex = exports.getIndexFieldsFromFind = exports.getIndexNameFromFields = exports.makeKeyFromPartialFilter = void 0;
+
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 
@@ -13,6 +17,7 @@ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/sli
 
 var _head = _interopRequireDefault(require("lodash/head"));
 
+var indexes = {};
 /**
  * Process a partial filter to generate a string key
  *
@@ -22,6 +27,7 @@ var _head = _interopRequireDefault(require("lodash/head"));
  * @param {object} condition - An object representing the partial filter or a sub-condition of the partial filter
  * @returns {string} - The string key of the processed partial filter
  */
+
 var makeKeyFromPartialFilter = function makeKeyFromPartialFilter(condition) {
   if (typeof condition !== 'object' || condition === null) {
     return String(condition);
@@ -92,7 +98,7 @@ var defaultSelector = {
   }
 };
 
-var getIndexFields = function getIndexFields(
+var getIndexFieldsFromFind = function getIndexFieldsFromFind(
 /** @type {import('./types').MangoQueryOptions} */
 _ref3) {
   var _ref3$selector = _ref3.selector,
@@ -104,5 +110,142 @@ _ref3) {
     return (0, _head.default)(Object.keys(sortOption));
   })), (0, _toConsumableArray2.default)(selector ? Object.keys(selector) : []), (0, _toConsumableArray2.default)(partialFilter ? Object.keys(partialFilter) : []))));
 };
+/**
+ * Create the PouchDB index if not existing
+ *
+ * @param {object} db - The pouch db
+ * @param {Array} fields - Fields to index
+ * @param {object} indexOption - Options for the index
+ * @param {object} [indexOption.partialFilter] - partialFilter
+ * @param {string} [indexOption.indexName] - indexName
+ * @param {string} [indexOption.doctype] - doctype
+ * @returns {Promise<import('./types').PouchDbIndex>}
+ */
+
+
+exports.getIndexFieldsFromFind = getIndexFieldsFromFind;
+
+var createIndex = /*#__PURE__*/function () {
+  var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(db, fields) {
+    var _ref5,
+        partialFilter,
+        indexName,
+        doctype,
+        absName,
+        index,
+        _args = arguments;
+
+    return _regenerator.default.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            _ref5 = _args.length > 2 && _args[2] !== undefined ? _args[2] : {}, partialFilter = _ref5.partialFilter, indexName = _ref5.indexName, doctype = _ref5.doctype;
+            absName = "".concat(doctype, "/").concat(indexName);
+            _context.next = 4;
+            return db.createIndex({
+              index: {
+                fields: fields,
+                ddoc: indexName,
+                indexName: indexName,
+                partial_filter_selector: partialFilter
+              }
+            });
+
+          case 4:
+            index = _context.sent;
+            indexes[absName] = index;
+            return _context.abrupt("return", index);
+
+          case 7:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee);
+  }));
+
+  return function createIndex(_x, _x2) {
+    return _ref4.apply(this, arguments);
+  };
+}();
+/**
+ * Retrieve the PouchDB index if exist, undefined otherwise
+ *
+ * @param {string} doctype - The query's doctype
+ * @param {import('./types').MangoQueryOptions} options - The find options
+ * @param {string} indexName - The index name
+ * @returns {import('./types').PouchDbIndex | undefined}
+ */
+
+
+exports.createIndex = createIndex;
+
+var findExistingIndex = function findExistingIndex(doctype, options, indexName) {
+  var absName = "".concat(doctype, "/").concat(indexName);
+  return indexes[absName];
+};
+
+exports.findExistingIndex = findExistingIndex;
+
+var getIndexFields = function getIndexFields(_ref6) {
+  var selector = _ref6.selector,
+      sort = _ref6.sort,
+      partialFilter = _ref6.partialFilter,
+      indexedFields = _ref6.indexedFields;
+  var fieldsToIndex = indexedFields;
+
+  if (!indexedFields) {
+    fieldsToIndex = getIndexFieldsFromFind({
+      selector: selector,
+      sort: sort,
+      partialFilter: partialFilter
+    });
+  } else if (partialFilter) {
+    // Some pouch adapters does not support partialIndex, e.g. with websql in react-native
+    // Therefore, we need to force the indexing the partialIndex fields to ensure they will be
+    // included in the actual index. Thanks to this, docs with missing fields will be excluded
+    // from the index.
+    // Note the $exists: false case should be handled in-memory.
+    fieldsToIndex = Array.from(new Set([].concat((0, _toConsumableArray2.default)(indexedFields), (0, _toConsumableArray2.default)(Object.keys(partialFilter))))); // FIXME: should properly handle n-level attributes
+
+    fieldsToIndex = indexedFields.filter(function (field) {
+      return field !== '$and' && field !== '$or';
+    });
+  }
+
+  return fieldsToIndex;
+};
+
+exports.getIndexFields = getIndexFields;
+
+var getIndexName = function getIndexName(_ref7) {
+  var selector = _ref7.selector,
+      sort = _ref7.sort,
+      indexedFields = _ref7.indexedFields,
+      partialFilter = _ref7.partialFilter;
+  var fieldsToIndex = indexedFields;
+
+  if (!indexedFields) {
+    fieldsToIndex = getIndexFieldsFromFind({
+      selector: selector,
+      sort: sort,
+      partialFilter: partialFilter
+    });
+  } else if (partialFilter) {
+    // Some pouch adapters does not support partialIndex, e.g. with websql in react-native
+    // Therefore, we need to force the indexing the partialIndex fields to ensure they will be
+    // included in the actual index. Thanks to this, docs with missing fields will be excluded
+    // from the index.
+    // Note the $exists: false case should be handled in-memory.
+    fieldsToIndex = Array.from(new Set([].concat((0, _toConsumableArray2.default)(indexedFields), (0, _toConsumableArray2.default)(Object.keys(partialFilter))))); // FIXME: should properly handle n-level attributes
+
+    fieldsToIndex = indexedFields.filter(function (field) {
+      return field !== '$and' && field !== '$or';
+    });
+  }
+
+  var indexName = getIndexNameFromFields(fieldsToIndex, partialFilter);
+  return indexName;
+};
 
-exports.getIndexFields = getIndexFields;
+exports.getIndexName = getIndexName;

package/dist/migrations/pouchdb.js

@@ -0,0 +1,32 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.destroyOldDatabases = void 0;
+
+var _utils = require("../utils");
+
+var destroyOldDatabases = function destroyOldDatabases(PouchDB, doctypes, prefix) {
+  if (doctypes) {
+    doctypes.forEach(function (doctype) {
+      // Check an old version of the db exist for this doctype
+      var db = new PouchDB((0, _utils.getOldDatabaseName)(prefix, doctype), {
+        skip_setup: true // Skip the db creation
+
+      });
+
+      if (db && db.info) {
+        db.info().then(function () {
+          // The database exists: destroy it
+          db.destroy();
+        }).catch(function (err) {
+          // No database found, nothing to do
+          return;
+        });
+      }
+    });
+  }
+};
+
+exports.destroyOldDatabases = destroyOldDatabases;

package/dist/replicateOnce.js

@@ -43,7 +43,7 @@ function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len
  */
 var replicateOnce = /*#__PURE__*/function () {
   var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(pouchManager) {
-    var doctypes, promises, res, zippedDoctypes, successZippedDoctypes, failedZippedDoctypes, blockingErrors, unblockingErrors, _iterator, _step, unblockingError, doctype, errors, reasons, doctypeUpdated, doctypeFailed;
+    var doctypes, promises, res, zippedDoctypes, successZippedDoctypes, failedZippedDoctypes, blockingErrors, unblockingErrors, _iterator, _step, unblockingError, _doctype, errors, reasons, doctypeUpdated, doctypeFailed;
 
     return _regenerator.default.wrap(function _callee2$(_context2) {
       while (1) {
@@ -67,12 +67,14 @@ var replicateOnce = /*#__PURE__*/function () {
 
 
             pouchManager.replications = (0, _map.default)(pouchManager.pouches, /*#__PURE__*/function () {
-              var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(pouch, doctype) {
-                var getReplicationURL, initialReplication, replicationFilter, seq, lastSeq, replicationOptions, res;
+              var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(pouch, dbName) {
+                var doctype, getReplicationURL, initialReplication, replicationFilter, seq, lastSeq, replicationOptions, res;
                 return _regenerator.default.wrap(function _callee$(_context) {
                   while (1) {
                     switch (_context.prev = _context.next) {
                       case 0:
+                        doctype = (0, _utils.getDoctypeFromDatabaseName)(dbName);
+
                         _logger.default.info('PouchManager: Starting replication for ' + doctype);
 
                         getReplicationURL = function getReplicationURL() {
@@ -88,30 +90,30 @@ var replicateOnce = /*#__PURE__*/function () {
                         seq = '';
 
                         if (!initialReplication) {
-                          _context.next = 13;
+                          _context.next = 14;
                           break;
                         }
 
-                        _context.next = 8;
+                        _context.next = 9;
                         return (0, _remote.fetchRemoteLastSequence)(getReplicationURL());
 
-                      case 8:
+                      case 9:
                         lastSeq = _context.sent;
-                        _context.next = 11;
+                        _context.next = 12;
                         return pouchManager.storage.persistDoctypeLastSequence(doctype, lastSeq);
 
-                      case 11:
-                        _context.next = 16;
+                      case 12:
+                        _context.next = 17;
                         break;
 
-                      case 13:
-                        _context.next = 15;
+                      case 14:
+                        _context.next = 16;
                         return pouchManager.storage.getDoctypeLastSequence(doctype);
 
-                      case 15:
+                      case 16:
                         seq = _context.sent;
 
-                      case 16:
+                      case 17:
                         replicationOptions = (0, _get.default)(pouchManager.doctypesReplicationOptions, doctype, {});
                         replicationOptions.initialReplication = initialReplication;
                         replicationOptions.filter = replicationFilter;
@@ -122,25 +124,25 @@ var replicateOnce = /*#__PURE__*/function () {
                           pouchManager.options.onDoctypeSyncStart(doctype);
                         }
 
-                        _context.next = 24;
+                        _context.next = 25;
                         return (0, _startReplication.startReplication)(pouch, replicationOptions, getReplicationURL, pouchManager.storage);
 
-                      case 24:
+                      case 25:
                         res = _context.sent;
 
                         if (!seq) {
-                          _context.next = 28;
+                          _context.next = 29;
                           break;
                         }
 
-                        _context.next = 28;
+                        _context.next = 29;
                         return pouchManager.storage.destroyDoctypeLastSequence(doctype);
 
-                      case 28:
-                        _context.next = 30;
+                      case 29:
+                        _context.next = 31;
                         return pouchManager.updateSyncInfo(doctype);
 
-                      case 30:
+                      case 31:
                         pouchManager.checkToWarmupDoctype(doctype, replicationOptions);
 
                         if (pouchManager.options.onDoctypeSyncEnd) {
@@ -149,7 +151,7 @@ var replicateOnce = /*#__PURE__*/function () {
 
                         return _context.abrupt("return", res);
 
-                      case 33:
+                      case 34:
                       case "end":
                         return _context.stop();
                     }
@@ -209,10 +211,10 @@ var replicateOnce = /*#__PURE__*/function () {
             }
 
             unblockingError = _step.value;
-            doctype = unblockingError[0]; // @ts-ignore
+            _doctype = unblockingError[0]; // @ts-ignore
 
             _context2.next = 28;
-            return pouchManager.updateSyncInfo(doctype, 'not_complete');
+            return pouchManager.updateSyncInfo(_doctype, 'not_complete');
 
           case 28:
             _context2.next = 23;

package/dist/types.js

@@ -1,10 +1,14 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
 
+var _dbInterface = _interopRequireDefault(require("./db/dbInterface"));
+
 /**
  * @typedef {Object} Cancelable
  * @property {Function} [cancel] - Cancel the promise
@@ -39,6 +43,7 @@ exports.default = void 0;
  * @typedef {object} LinkPlatform
  * @property {LocalStorage} storage Methods to access local storage
  * @property {any} pouchAdapter PouchDB class (can be pouchdb-core or pouchdb-browser)
+ * @property { DatabaseQueryEngine } queryEngine
  * @property {function(): Promise<boolean>} isOnline Method that check if the app is connected to internet
  */
 

package/dist/utils.js

@@ -3,8 +3,8 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.allSettled = exports.formatAggregatedError = exports.getPrefix = exports.getDatabaseName = void 0;
-
+exports.allSettled = exports.formatAggregatedError = exports.getPrefix = exports.getDoctypeFromDatabaseName = exports.getOldDatabaseName = exports.getDatabaseName = exports.DATABASE_NAME_SEPARATOR = void 0;
+var DATABASE_NAME_SEPARATOR = '__doctype__';
 /**
  * Get the database name based on prefix and doctype
  *
@@ -13,9 +13,39 @@ exports.allSettled = exports.formatAggregatedError = exports.getPrefix = exports
  *
  * @returns {string} The database name
  */
+
+exports.DATABASE_NAME_SEPARATOR = DATABASE_NAME_SEPARATOR;
+
 var getDatabaseName = function getDatabaseName(prefix, doctype) {
+  return "".concat(prefix).concat(DATABASE_NAME_SEPARATOR).concat(doctype);
+};
+/**
+ * Get the old database name, based on prefix and doctype
+ * Used for migration purposes
+ *
+ * @param {string} prefix - The URL prefix
+ * @param {string} doctype - The database doctype
+ *
+ * @returns {string} The database name
+ */
+
+
+exports.getDatabaseName = getDatabaseName;
+
+var getOldDatabaseName = function getOldDatabaseName(prefix, doctype) {
   return "".concat(prefix, "_").concat(doctype);
 };
+
+exports.getOldDatabaseName = getOldDatabaseName;
+
+var getDoctypeFromDatabaseName = function getDoctypeFromDatabaseName(dbName) {
+  if (!dbName) {
+    return null;
+  }
+
+  var tokens = dbName.split(DATABASE_NAME_SEPARATOR);
+  return tokens[tokens.length - 1];
+};
 /**
  * Get the URI prefix
  *
@@ -24,7 +54,7 @@ var getDatabaseName = function getDatabaseName(prefix, doctype) {
  */
 
 
-exports.getDatabaseName = getDatabaseName;
+exports.getDoctypeFromDatabaseName = getDoctypeFromDatabaseName;
 
 var getPrefix = function getPrefix(uri) {
   return uri.replace(/^https?:\/\//, '');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-pouch-link",
-  "version": "57.5.0",
+  "version": "57.6.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": "^57.5.0",
+    "cozy-client": "^57.6.0",
     "pouchdb-browser": "^7.2.2",
     "pouchdb-find": "^7.2.2"
   },
@@ -30,6 +30,7 @@
   },
   "peerDependencies": {
     "@cozy/minilog": "1.0.0",
+    "@op-engineering/op-sqlite": "*",
     "cozy-device-helper": ">=2.1.0"
   },
   "scripts": {
@@ -39,5 +40,5 @@
     "typecheck": "tsc -p tsconfig.json"
   },
   "sideEffects": false,
-  "gitHead": "1244b5d668b419f7c10e7474160211b3ec6bbe41"
+  "gitHead": "5a646c30c51b7a93ea7e65d309425799487b1968"
 }

package/types/CozyPouchLink.d.ts

@@ -125,6 +125,7 @@ declare class PouchLink extends CozyLink {
         plugins?: Array<object>;
     }): Promise<void>;
     onLogin(): Promise<void>;
+    queryEngine: import("./db/dbInterface").default | typeof PouchDBQueryEngine;
     pouches: PouchManager;
     /**
      * Receives PouchDB updates (documents grouped by doctype).
@@ -180,6 +181,7 @@ declare class PouchLink extends CozyLink {
     public stopReplication(): void;
     onSyncError(error: any): Promise<void>;
     getSyncInfo(doctype: any): import("./types").SyncInfo;
+    getQueryEngineFromDoctype(doctype: any): any;
     getPouch(doctype: any): any;
     supportsOperation(operation: any): boolean;
     /**
@@ -199,17 +201,6 @@ declare class PouchLink extends CozyLink {
      * @returns {Promise<import('./types').PouchDBInfo>} The db info
      */
     getDbInfo(doctype: string): Promise<import('./types').PouchDBInfo>;
-    sanitizeJsonApi(data: any): Pick<Pick<any, string | number | symbol>, string | number | symbol>;
-    /**
-     * Retrieve the existing document from Pouch
-     *
-     * @private
-     * @param {*} id - ID of the document to retrieve
-     * @param {*} type - Doctype of the document to retrieve
-     * @param {*} throwIfNotFound - If true the method will throw when the document is not found. Otherwise it will return null
-     * @returns {Promise<CozyClientDocument | null>}
-     */
-    private getExistingDocument;
     /**
      *
      * Check if there is warmup queries for this doctype
@@ -220,45 +211,6 @@ declare class PouchLink extends CozyLink {
      */
     needsToWaitWarmup(doctype: string): Promise<boolean>;
     hasIndex(name: any): boolean;
-    /**
-     * Create the PouchDB index if not existing
-     *
-     * @param {Array} fields - Fields to index
-     * @param {object} indexOption - Options for the index
-     * @param {object} [indexOption.partialFilter] - partialFilter
-     * @param {string} [indexOption.indexName] - indexName
-     * @param {string} [indexOption.doctype] - doctype
-     * @returns {Promise<import('./types').PouchDbIndex>}
-     */
-    createIndex(fields: any[], { partialFilter, indexName, doctype }?: {
-        partialFilter: object;
-        indexName: string;
-        doctype: string;
-    }): Promise<import('./types').PouchDbIndex>;
-    /**
-     * Retrieve the PouchDB index if exist, undefined otherwise
-     *
-     * @param {string} doctype - The query's doctype
-     * @param {import('./types').MangoQueryOptions} options - The find options
-     * @param {string} indexName - The index name
-     * @returns {import('./types').PouchDbIndex | undefined}
-     */
-    findExistingIndex(doctype: string, options: import('./types').MangoQueryOptions, indexName: string): import('./types').PouchDbIndex | undefined;
-    /**
-     * Handle index creation if it is missing.
-     *
-     * When an index is missing, we first check if there is one with a different
-     * name but the same definition. If there is none, we create the new index.
-     *
-     * /!\ Warning: this method is similar to DocumentCollection.handleMissingIndex()
-     * If you edit this method, please check if the change is also needed in DocumentCollection
-     *
-     * @param {string} doctype The mango selector
-     * @param {import('./types').MangoQueryOptions} options The find options
-     * @returns {Promise<import('./types').PouchDbIndex>} index
-     * @private
-     */
-    private ensureIndex;
     executeQuery({ doctype, selector, sort, fields, limit, id, ids, skip, indexedFields, partialFilter }: {
         doctype: any;
         selector: any;
@@ -270,16 +222,7 @@ declare class PouchLink extends CozyLink {
         skip: any;
         indexedFields: any;
         partialFilter: any;
-    }): Promise<{
-        data: any;
-        meta: {
-            count: any;
-        };
-        skip: any;
-        next: boolean;
-    } | {
-        data: any;
-    }>;
+    }): Promise<any>;
     executeMutation(mutation: any, options: any, result: any, forward: any): Promise<any>;
     createDocument(mutation: any): Promise<any>;
     updateDocument(mutation: any): Promise<any>;
@@ -291,4 +234,5 @@ declare class PouchLink extends CozyLink {
 }
 import { CozyLink } from "cozy-client";
 import { PouchLocalStorage } from "./localStorage";
+import PouchDBQueryEngine from "./db/pouchdb/pouchdb";
 import PouchManager from "./PouchManager";

package/types/PouchManager.d.ts

@@ -10,9 +10,12 @@ declare class PouchManager {
     options: any;
     doctypes: any;
     storage: PouchLocalStorage;
+    queryEngine: any;
+    client: any;
     PouchDB: any;
     isOnline: any;
     events: any;
+    dbQueryEngines: Map<any, any>;
     init(): Promise<void>;
     pouches: import("lodash").Dictionary<any>;
     /** @type {Record<string, import('./types').SyncInfo>} - Stores synchronization info per doctype */
@@ -62,7 +65,9 @@ declare class PouchManager {
     handleReplicationError(err: any): void;
     cancelCurrentReplications(): void;
     waitForCurrentReplications(): Promise<void> | Promise<(import("./utils").FulfilledPromise | import("./utils").RejectedPromise)[]>;
-    getPouch(doctype: any): any;
+    getPouch(dbName: any): any;
+    setQueryEngine(name: any, doctype: any): any;
+    getQueryEngine(name: any, doctype: any): any;
     /**
      * Update the Sync info for the specifed doctype
      *

package/types/__mocks__/@op-engineering/op-sqlite.d.ts

@@ -0,0 +1 @@
+export function open(): void;