cozy-pouch-link 57.5.0 → 57.6.1

package/dist/jsonapi.js

@@ -2,19 +2,33 @@
 
 var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard");
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.fromPouchResult = exports.normalizeDoc = exports.normalizeDocs = void 0;
+exports.sanitizeJsonApi = exports.sanitized = exports.fromPouchResult = exports.normalizeDoc = exports.normalizeDocs = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
 var _cozyClient = _interopRequireWildcard(require("cozy-client"));
 
+var _omit = _interopRequireDefault(require("lodash/omit"));
+
+var _startsWith = _interopRequireDefault(require("lodash/startsWith"));
+
+var _helpers = require("./db/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; }
+
 /**
  * Normalize several PouchDB document
  *
  * @param {CozyClient} client - The CozyClient instance
  * @param {string} doctype - The document's doctype
- * @param {Array<import('./CozyPouchLink').CozyClientDocument>} docs - The documents to normalize
+ * @param {Array<import('./CozyPouchLink').CozyPouchDocument>} docs - The documents to normalize
  */
 var normalizeDocs = function normalizeDocs(client, doctype, docs) {
   for (var i = docs.length; i >= 0; i--) {
@@ -25,6 +39,11 @@ var normalizeDocs = function normalizeDocs(client, doctype, docs) {
       continue;
     }
 
+    if ((0, _startsWith.default)(doc.id, '_design/')) {
+      docs.splice(i, 1);
+      continue;
+    }
+
     normalizeDoc(client, doctype, doc);
   }
 };
@@ -35,7 +54,7 @@ var normalizeDocs = function normalizeDocs(client, doctype, docs) {
  *
  * @param {CozyClient} client - The CozyClient instance
  * @param {string} doctype - The document's doctype
- * @param {import('./CozyPouchLink').CozyClientDocument} doc - The document to normalize
+ * @param {import('./CozyPouchLink').CozyPouchDocument} doc - The document to normalize
  */
 
 
@@ -48,12 +67,15 @@ var normalizeDoc = function normalizeDoc(client, doctype, doc) {
   doc._rev = doc._rev || doc.rev;
   doc._type = doctype;
 
-  if (doc.relationships) {
-    doc.relationships.referenced_by = doc.referenced_by;
-  } else {
-    doc.relationships = {
-      referenced_by: doc.referenced_by
-    };
+  if (doc.referenced_by) {
+    // TODO: should we remove referenced_by at the doc root?
+    // For now, we keep it for safety
+    doc.relationships = _objectSpread(_objectSpread({}, doc.relationships), {}, {
+      referenced_by: {
+        links: undefined,
+        data: doc.referenced_by
+      }
+    });
   }
 
   if (doc.rev) {
@@ -93,17 +115,16 @@ var fromPouchResult = function fromPouchResult(_ref) {
       doctype = _ref.doctype,
       client = _ref.client;
 
-  // Sometimes, queries are transformed by Collections and they call a dedicated
-  // cozy-stack route. When this is the case, we want to be able to replicate the same
-  // query from cozy-pouch-link. It is not possible as-is because the received data
-  // is not the same as the one stored in the Couch database
-  // To handle this, we store the received data in the Pouch with a dedicated id and
-  // we store the query result in a `cozyPouchData` attribute
-  // So when `cozyPouchData` attribute exists, we know that we want to return its content
-  // as the result of the query
-  if (res.cozyPouchData) {
+  if (!res) {
+    return null;
+  } // Handle special case for docs with `cozyPouchData`
+
+
+  var cozyPouchData = (0, _helpers.getCozyPouchData)(res);
+
+  if (cozyPouchData) {
     return {
-      data: res.cozyPouchData
+      data: cozyPouchData
     };
   }
 
@@ -112,6 +133,7 @@ var fromPouchResult = function fromPouchResult(_ref) {
       return row.doc;
     }) : res.docs;
     var offset = res.offset || 0;
+    var next = offset + docs.length < res.total_rows || docs.length >= res.limit;
     normalizeDocs(client, doctype, docs);
     var result = {
       data: docs,
@@ -119,7 +141,7 @@ var fromPouchResult = function fromPouchResult(_ref) {
         count: docs.length
       },
       skip: offset,
-      next: offset + docs.length < res.total_rows || docs.length >= res.limit
+      next: next
     };
     return result;
   } else {
@@ -130,4 +152,18 @@ var fromPouchResult = function fromPouchResult(_ref) {
   }
 };
 
-exports.fromPouchResult = fromPouchResult;
+exports.fromPouchResult = fromPouchResult;
+
+var sanitized = function sanitized(doc) {
+  return (0, _omit.default)(doc, '_type');
+};
+
+exports.sanitized = sanitized;
+
+var sanitizeJsonApi = function sanitizeJsonApi(doc) {
+  var docWithoutType = sanitized(doc);
+  var sanitizedDoc = (0, _omit.default)(docWithoutType, ['attributes', 'meta']);
+  return sanitizedDoc;
+};
+
+exports.sanitizeJsonApi = sanitizeJsonApi;

package/dist/jsonapi.spec.js

@@ -34,24 +34,99 @@ const client = new CozyClient({ token, uri })
 client.capabilities = { flat_subdomains: true }
 
 describe('doc normalization', () => {
+  it('should correctly normalize simple doc', () => {
+    const doc = {
+      _id: '1234',
+      _rev: '1-1234',
+      name: 'Simple doc'
+    }
+    normalizeDoc(client, 'io.cozy.todos', doc)
+    expect(doc).toEqual({
+      _id: '1234',
+      id: '1234',
+      _rev: '1-1234',
+      _type: 'io.cozy.todos',
+      name: 'Simple doc'
+    })
+  })
+
+  it('should handle wrong rev format', () => {
+    const doc = {
+      _id: '1234',
+      rev: '1-1234',
+      name: 'Simple doc'
+    }
+    normalizeDoc(client, 'io.cozy.todos', doc)
+    expect(doc).toEqual({
+      _id: '1234',
+      id: '1234',
+      _rev: '1-1234',
+      _type: 'io.cozy.todos',
+      name: 'Simple doc'
+    })
+  })
+
+  it('should normalize relationships', () => {
+    const doc = {
+      _id: '1234',
+      rev: '1-1234',
+      name: 'Simple doc',
+      relationships: {
+        contact: {
+          data: {
+            _id: '4567',
+            _type: 'io.cozy.contacts'
+          }
+        }
+      },
+      referenced_by: [
+        {
+          type: 'io.cozy.albums',
+          id: 'thegreatalbum'
+        }
+      ]
+    }
+    normalizeDoc(client, 'io.cozy.todos', doc)
+    expect(doc).toMatchObject({
+      _id: '1234',
+      id: '1234',
+      _rev: '1-1234',
+      _type: 'io.cozy.todos',
+      name: 'Simple doc',
+      relationships: {
+        contact: {
+          data: {
+            _id: '4567',
+            _type: 'io.cozy.contacts'
+          }
+        },
+        referenced_by: {
+          data: [
+            {
+              type: 'io.cozy.albums',
+              id: 'thegreatalbum'
+            }
+          ]
+        }
+      }
+    })
+  })
+
   it('should normalize apps links', () => {
     const doc = {
-      _id: 1234,
+      _id: '1234',
       _rev: '3-deadbeef',
       slug: 'contact',
       version: '1.2.0'
     }
     normalizeDoc(client, 'io.cozy.apps', doc)
     expect(doc).toEqual({
-      _id: 1234,
-      id: 1234,
+      _id: '1234',
+      id: '1234',
       _rev: '3-deadbeef',
       _type: 'io.cozy.apps',
       slug: 'contact',
       version: '1.2.0',
-      relationships: {
-        referenced_by: undefined
-      },
       links: {
         icon: '/apps/contact/icon/1.2.0',
         related: 'https://claude-contact.mycozy.cloud/#/',
@@ -188,9 +263,6 @@ describe('jsonapi', () => {
           links: {
             self: '/settings/flags'
           },
-          relationships: {
-            referenced_by: undefined
-          },
           'some.boolean.flag': true,
           'some.number.flag': 30,
           'some.object.flag': {
@@ -214,9 +286,6 @@ describe('jsonapi', () => {
     expect(normalized).toEqual({
       data: [
         {
-          relationships: {
-            referenced_by: undefined
-          },
           id: '018bdcec-00c8-7155-b352-c8a8f472f882',
           type: 'file',
           _type: 'io.cozy.files',
@@ -258,12 +327,14 @@ describe('jsonapi', () => {
         },
         {
           relationships: {
-            referenced_by: [
-              {
-                id: '536bde9aef87dde16630d3c99d26453f',
-                type: 'io.cozy.photos.albums'
-              }
-            ]
+            referenced_by: {
+              data: [
+                {
+                  id: '536bde9aef87dde16630d3c99d26453f',
+                  type: 'io.cozy.photos.albums'
+                }
+              ]
+            }
           },
           id: '018c7cf1-1d00-73ac-9a7f-ee3190638183',
           type: 'file',
@@ -315,18 +386,26 @@ describe('jsonapi', () => {
           _rev: '2-02e800df012ea1cc740e5ad1554cefe6'
         },
         {
-          relationships: {
-            referenced_by: [
-              {
-                id: '536bde9aef87dde16630d3c99d26453f',
-                type: 'io.cozy.photos.albums'
-              }
-            ]
-          },
           id: '018ca6a8-8292-7acb-bcaf-a95ccfd83662',
           _type: 'io.cozy.files',
           type: 'file',
           name: 'IMG_0047.jpg',
+          relationships: {
+            referenced_by: {
+              data: [
+                {
+                  id: '536bde9aef87dde16630d3c99d26453f',
+                  type: 'io.cozy.photos.albums'
+                }
+              ]
+            }
+          },
+          referenced_by: [
+            {
+              id: '536bde9aef87dde16630d3c99d26453f',
+              type: 'io.cozy.photos.albums'
+            }
+          ],
           dir_id: 'io.cozy.files.root-dir',
           created_at: '2023-11-19T13:31:47+01:00',
           updated_at: '2023-12-26T15:05:10.256Z',
@@ -346,12 +425,6 @@ describe('jsonapi', () => {
             orientation: 6,
             width: 4032
           },
-          referenced_by: [
-            {
-              id: '536bde9aef87dde16630d3c99d26453f',
-              type: 'io.cozy.photos.albums'
-            }
-          ],
           cozyMetadata: {
             doctypeVersion: '1',
             metadataVersion: 1,

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
  */