cozy-pouch-link 48.25.0 → 49.0.0

package/dist/localStorage.spec.js

@@ -0,0 +1,48 @@
+import { PouchLocalStorage } from './localStorage'
+
+describe('LocalStorage', () => {
+  describe('Type assertion', () => {
+    it('should throw if setItem method is missing', () => {
+      expect(() => {
+        new PouchLocalStorage({
+          getItem: jest.fn(),
+          removeItem: jest.fn()
+        })
+      }).toThrow(
+        'Provided storageEngine is missing the following methods: setItem'
+      )
+    })
+
+    it('should throw if getItem method is missing', () => {
+      expect(() => {
+        new PouchLocalStorage({
+          setItem: jest.fn(),
+          removeItem: jest.fn()
+        })
+      }).toThrow(
+        'Provided storageEngine is missing the following methods: getItem'
+      )
+    })
+
+    it('should throw if removeItem method is missing', () => {
+      expect(() => {
+        new PouchLocalStorage({
+          getItem: jest.fn(),
+          setItem: jest.fn()
+        })
+      }).toThrow(
+        'Provided storageEngine is missing the following methods: removeItem'
+      )
+    })
+
+    it('should throw if multiple methods are missing', () => {
+      expect(() => {
+        new PouchLocalStorage({
+          getItem: jest.fn()
+        })
+      }).toThrow(
+        'Provided storageEngine is missing the following methods: setItem, removeItem'
+      )
+    })
+  })
+})

package/dist/mango.js

@@ -5,28 +5,74 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getIndexFields = exports.getIndexNameFromFields = void 0;
+exports.getIndexFields = exports.getIndexNameFromFields = exports.makeKeyFromPartialFilter = void 0;
 
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 
-var _flatten = _interopRequireDefault(require("lodash/flatten"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 
-var _isObject = _interopRequireDefault(require("lodash/isObject"));
+var _head = _interopRequireDefault(require("lodash/head"));
 
-var getIndexNameFromFields = function getIndexNameFromFields(fields) {
-  return "by_".concat(fields.join('_and_'));
+/**
+ * Process a partial filter to generate a string key
+ *
+ * /!\ Warning: this method is similar to cozy-stack-client mangoIndex.makeKeyFromPartialFilter()
+ * If you edit this method, please check if the change is also needed in mangoIndex file
+ *
+ * @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);
+  }
+
+  var conditions = Object.entries(condition).map(function (_ref) {
+    var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
+        key = _ref2[0],
+        value = _ref2[1];
+
+    if (Array.isArray(value) && value.every(function (subObj) {
+      return typeof subObj === 'string';
+    })) {
+      return "".concat(key, "_(").concat(value.join('_'), ")");
+    } else if (Array.isArray(value)) {
+      return "(".concat(value.map(function (subCondition) {
+        return "".concat(makeKeyFromPartialFilter(subCondition));
+      }).join(")_".concat(key, "_(")), ")");
+    } else if (typeof value === 'object') {
+      return "".concat(key, "_").concat(makeKeyFromPartialFilter(value));
+    } else {
+      return "".concat(key, "_").concat(value);
+    }
+  });
+  return conditions.join(')_and_(');
 };
+/**
+ * Name an index, based on its indexed fields and partial filter.
+ *
+ * It follows this naming convention:
+ * `by_{indexed_field1}_and_{indexed_field2}_filter_({partial_filter.key1}_{partial_filter.value1})_and_({partial_filter.key2}_{partial_filter.value2})`
+ *
+ * /!\ Warning: this method is similar to cozy-stack-client mangoIndex.getIndexNameFromFields()
+ * If you edit this method, please check if the change is also needed in mangoIndex file
+ *
+ * @param {Array<string>} fields - The indexed fields
+ * @param {object} [partialFilter] - The partial filter
+ * @returns {string} The index name, built from the fields
+ */
 
-exports.getIndexNameFromFields = getIndexNameFromFields;
 
-var getSortKeys = function getSortKeys(sort) {
-  if (Array.isArray(sort)) {
-    return (0, _flatten.default)(sort.map(function (x) {
-      return Object.keys(x);
-    }));
-  } else if ((0, _isObject.default)(sort)) {
-    return Object.keys(sort);
+exports.makeKeyFromPartialFilter = makeKeyFromPartialFilter;
+
+var getIndexNameFromFields = function getIndexNameFromFields(fields, partialFilter) {
+  var indexName = "by_".concat(fields.join('_and_'));
+
+  if (partialFilter) {
+    return "".concat(indexName, "_filter_(").concat(makeKeyFromPartialFilter(partialFilter), ")");
   }
+
+  return indexName;
 };
 /**
  * @function
@@ -34,23 +80,29 @@ var getSortKeys = function getSortKeys(sort) {
  * query to work
  *
  * @private
- * @param  {object} options - Mango query options
+ * @param  {import('./types').MangoQueryOptions} options - Mango query options
  * @returns {Array} - Fields to index
  */
 
 
+exports.getIndexNameFromFields = getIndexNameFromFields;
 var defaultSelector = {
   _id: {
     $gt: null
   }
 };
 
-var getIndexFields = function getIndexFields(_ref) {
-  var _ref$selector = _ref.selector,
-      selector = _ref$selector === void 0 ? defaultSelector : _ref$selector,
-      _ref$sort = _ref.sort,
-      sort = _ref$sort === void 0 ? {} : _ref$sort;
-  return Array.from(new Set([].concat((0, _toConsumableArray2.default)(Object.keys(selector)), (0, _toConsumableArray2.default)(getSortKeys(sort)))));
+var getIndexFields = function getIndexFields(
+/** @type {import('./types').MangoQueryOptions} */
+_ref3) {
+  var _ref3$selector = _ref3.selector,
+      selector = _ref3$selector === void 0 ? defaultSelector : _ref3$selector,
+      _ref3$sort = _ref3.sort,
+      sort = _ref3$sort === void 0 ? [] : _ref3$sort,
+      partialFilter = _ref3.partialFilter;
+  return Array.from(new Set([].concat((0, _toConsumableArray2.default)(sort.map(function (sortOption) {
+    return (0, _head.default)(Object.keys(sortOption));
+  })), (0, _toConsumableArray2.default)(selector ? Object.keys(selector) : []), (0, _toConsumableArray2.default)(partialFilter ? Object.keys(partialFilter) : []))));
 };
 
 exports.getIndexFields = getIndexFields;

package/dist/mango.spec.js

@@ -6,6 +6,6 @@ describe('mango utils', () => {
   it('should be able to get the fields from the selector', () => {
     const query = Q('io.cozy.rockets').sortBy([{ label: true }, { _id: true }])
     const fields = getIndexFields(query)
-    expect(fields).toEqual(['_id', 'label'])
+    expect(fields).toEqual(['label', '_id'])
   })
 })

package/dist/migrations/adapter.js

@@ -25,7 +25,7 @@ var getNewIndexedDBDatabaseName = function getNewIndexedDBDatabaseName(dbName) {
  * @property {string} [toAdapter] - The new adapter type, e.g. 'indexeddb'
  *
  * @param {MigrationParams} params - The migration params
- * @returns {object} - The migrated pouch
+ * @returns {Promise<object>} - The migrated pouch
  */
 
 

package/dist/platformWeb.js

@@ -0,0 +1,120 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.platformWeb = void 0;
+
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+
+var _pouchdbBrowser = _interopRequireDefault(require("pouchdb-browser"));
+
+var events = {
+  addEventListener: function addEventListener(eventName, handler) {
+    document.addEventListener(eventName, handler);
+  },
+  removeEventListener: function removeEventListener(eventName, handler) {
+    document.removeEventListener(eventName, handler);
+  }
+};
+var storage = {
+  getItem: function () {
+    var _getItem = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(key) {
+      return _regenerator.default.wrap(function _callee$(_context) {
+        while (1) {
+          switch (_context.prev = _context.next) {
+            case 0:
+              return _context.abrupt("return", window.localStorage.getItem(key));
+
+            case 1:
+            case "end":
+              return _context.stop();
+          }
+        }
+      }, _callee);
+    }));
+
+    function getItem(_x) {
+      return _getItem.apply(this, arguments);
+    }
+
+    return getItem;
+  }(),
+  setItem: function () {
+    var _setItem = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(key, value) {
+      return _regenerator.default.wrap(function _callee2$(_context2) {
+        while (1) {
+          switch (_context2.prev = _context2.next) {
+            case 0:
+              return _context2.abrupt("return", window.localStorage.setItem(key, value));
+
+            case 1:
+            case "end":
+              return _context2.stop();
+          }
+        }
+      }, _callee2);
+    }));
+
+    function setItem(_x2, _x3) {
+      return _setItem.apply(this, arguments);
+    }
+
+    return setItem;
+  }(),
+  removeItem: function () {
+    var _removeItem = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(key) {
+      return _regenerator.default.wrap(function _callee3$(_context3) {
+        while (1) {
+          switch (_context3.prev = _context3.next) {
+            case 0:
+              return _context3.abrupt("return", window.localStorage.removeItem(key));
+
+            case 1:
+            case "end":
+              return _context3.stop();
+          }
+        }
+      }, _callee3);
+    }));
+
+    function removeItem(_x4) {
+      return _removeItem.apply(this, arguments);
+    }
+
+    return removeItem;
+  }()
+};
+
+var isOnline = /*#__PURE__*/function () {
+  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
+    return _regenerator.default.wrap(function _callee4$(_context4) {
+      while (1) {
+        switch (_context4.prev = _context4.next) {
+          case 0:
+            return _context4.abrupt("return", window.navigator.onLine);
+
+          case 1:
+          case "end":
+            return _context4.stop();
+        }
+      }
+    }, _callee4);
+  }));
+
+  return function isOnline() {
+    return _ref.apply(this, arguments);
+  };
+}();
+
+var platformWeb = {
+  storage: storage,
+  events: events,
+  pouchAdapter: _pouchdbBrowser.default,
+  isOnline: isOnline
+};
+exports.platformWeb = platformWeb;

package/dist/remote.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.fetchRemoteLastSequence = exports.fetchRemoteInstance = void 0;
+exports.fetchRemoteLastSequence = exports.fetchRemoteInstance = exports.isDatabaseUnradableError = exports.isDatabaseNotFoundError = exports.DATABASE_RESERVED_DOCTYPE_ERROR = exports.DATABASE_NOT_FOUND_ERROR = void 0;
 
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
@@ -13,13 +13,31 @@ var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/
 
 var _AccessToken = _interopRequireDefault(require("./AccessToken"));
 
+var DATABASE_NOT_FOUND_ERROR = 'Database does not exist';
+exports.DATABASE_NOT_FOUND_ERROR = DATABASE_NOT_FOUND_ERROR;
+var DATABASE_RESERVED_DOCTYPE_ERROR = 'Reserved doctype';
+exports.DATABASE_RESERVED_DOCTYPE_ERROR = DATABASE_RESERVED_DOCTYPE_ERROR;
+
+var isDatabaseNotFoundError = function isDatabaseNotFoundError(error) {
+  return error.message === DATABASE_NOT_FOUND_ERROR;
+};
+
+exports.isDatabaseNotFoundError = isDatabaseNotFoundError;
+
+var isDatabaseUnradableError = function isDatabaseUnradableError(error) {
+  return error.message === DATABASE_RESERVED_DOCTYPE_ERROR;
+};
 /**
  * Fetch remote instance
  *
  * @param {URL} url - The remote instance URL, including the credentials
  * @param {object} params - The params to query the remote instance
- * @returns {object} The instance response
+ * @returns {Promise<object>} The instance response
  */
+
+
+exports.isDatabaseUnradableError = isDatabaseUnradableError;
+
 var fetchRemoteInstance = /*#__PURE__*/function () {
   var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(url) {
     var params,
@@ -66,9 +84,25 @@ var fetchRemoteInstance = /*#__PURE__*/function () {
             return _context.abrupt("return", data);
 
           case 16:
-            return _context.abrupt("return", null);
+            if (!(resp.status === 404)) {
+              _context.next = 18;
+              break;
+            }
+
+            throw new Error(DATABASE_NOT_FOUND_ERROR);
+
+          case 18:
+            if (!(resp.status === 403 && data.error.includes('message=reserved doctype'))) {
+              _context.next = 20;
+              break;
+            }
+
+            throw new Error(DATABASE_RESERVED_DOCTYPE_ERROR);
+
+          case 20:
+            throw new Error("Error (".concat(resp.status, ") while fetching remote instance: ").concat(JSON.stringify(data)));
 
-          case 17:
+          case 21:
           case "end":
             return _context.stop();
         }
@@ -84,7 +118,7 @@ var fetchRemoteInstance = /*#__PURE__*/function () {
  * Fetch last sequence from remote instance
  *
  * @param {string} baseUrl - The base URL of the remote instance
- * @returns {string} The last sequence
+ * @returns {Promise<string>} The last sequence
  */
 
 

package/dist/remote.spec.js

@@ -0,0 +1,214 @@
+import { enableFetchMocks, disableFetchMocks } from 'jest-fetch-mock'
+
+import {
+  DATABASE_NOT_FOUND_ERROR,
+  DATABASE_RESERVED_DOCTYPE_ERROR,
+  fetchRemoteInstance,
+  fetchRemoteLastSequence
+} from './remote'
+
+describe('remote', () => {
+  beforeAll(() => {
+    enableFetchMocks()
+  })
+
+  beforeEach(() => {
+    fetch.resetMocks()
+  })
+
+  afterAll(() => {
+    disableFetchMocks()
+  })
+
+  describe('fetchRemoteInstance', () => {
+    it(`Should add Authorization header based on URL's password`, async () => {
+      const remoteUrl =
+        'https://user:SOME_TOKEN@claude.mycozy.cloud/data/io.cozy.accounts/_changes'
+
+      mockDatabaseOn(
+        'https://claude.mycozy.cloud/data/io.cozy.accounts/_changes'
+      )
+
+      await fetchRemoteInstance(new URL(remoteUrl))
+
+      const expectedHeaders = new Headers()
+      expectedHeaders.append('Accept', 'application/json')
+      expectedHeaders.append('Content-Type', 'application/json')
+      expectedHeaders.append('Authorization', 'Bearer SOME_TOKEN')
+
+      expect(fetch).toHaveBeenCalledWith(
+        'https://claude.mycozy.cloud/data/io.cozy.accounts/_changes',
+        {
+          headers: expectedHeaders
+        }
+      )
+    })
+
+    it('Should return data when found', async () => {
+      const remoteUrl =
+        'https://user:SOME_TOKEN@claude.mycozy.cloud/data/io.cozy.accounts/_changes?limit=1&descending=true'
+      mockDatabaseOn(
+        'https://claude.mycozy.cloud/data/io.cozy.accounts/_changes?limit=1&descending=true'
+      )
+
+      const result = await fetchRemoteInstance(new URL(remoteUrl))
+
+      expect(result).toStrictEqual({
+        last_seq: '97-SOME_SEQ_VALUE',
+        pending: -1,
+        results: [
+          {
+            id: 'SOME_ID',
+            seq: '97-SOME_SEQ_VALUE',
+            doc: null,
+            changes: [{ rev: '3-SOME_REV' }]
+          }
+        ]
+      })
+    })
+
+    it('Should add parameters when given', async () => {
+      const remoteUrl =
+        'https://user:SOME_TOKEN@claude.mycozy.cloud/data/io.cozy.accounts/_changes'
+
+      mockDatabaseOn(
+        'https://claude.mycozy.cloud/data/io.cozy.accounts/_changes?limit=1&descending=true'
+      )
+
+      await fetchRemoteInstance(new URL(remoteUrl), {
+        limit: 1,
+        descending: true
+      })
+
+      const expectedHeaders = new Headers()
+      expectedHeaders.append('Accept', 'application/json')
+      expectedHeaders.append('Content-Type', 'application/json')
+      expectedHeaders.append('Authorization', 'Bearer SOME_TOKEN')
+
+      expect(fetch).toHaveBeenCalledWith(
+        'https://claude.mycozy.cloud/data/io.cozy.accounts/_changes?limit=1&descending=true',
+        expect.anything()
+      )
+    })
+
+    it('Should throw when 404 error', async () => {
+      const remoteUrl =
+        'https://user:SOME_TOKEN@claude.mycozy.cloud/data/io.cozy.accounts/_changes?limit=1&descending=true'
+
+      mockDatabaseNotFoundOn(
+        'https://claude.mycozy.cloud/data/io.cozy.accounts/_changes?limit=1&descending=true'
+      )
+
+      await expect(fetchRemoteInstance(new URL(remoteUrl))).rejects.toThrow(
+        DATABASE_NOT_FOUND_ERROR
+      )
+    })
+  })
+
+  describe('fetchRemoteLastSequence', () => {
+    it('Should return data when found', async () => {
+      const remoteUrl =
+        'https://user:SOME_TOKEN@claude.mycozy.cloud/data/io.cozy.accounts'
+      mockDatabaseOn(
+        'https://claude.mycozy.cloud/data/io.cozy.accounts/_changes?limit=1&descending=true'
+      )
+
+      const result = await fetchRemoteLastSequence(remoteUrl)
+
+      expect(result).toBe('97-SOME_SEQ_VALUE')
+    })
+
+    it('Shoud throw when HTTP error', async () => {
+      const remoteUrl =
+        'https://user:SOME_TOKEN@claude.mycozy.cloud/data/io.cozy.accounts'
+      mockUnknownErrorOn(
+        'https://claude.mycozy.cloud/data/io.cozy.accounts/_changes?limit=1&descending=true'
+      )
+
+      await expect(fetchRemoteLastSequence(remoteUrl)).rejects.toThrow(
+        'Error (503) while fetching remote instance: {"error":"code=503, message=SOME UNKNOWN ERROR"}'
+      )
+    })
+
+    it('Shoud throw dedicated error when 404 error', async () => {
+      const remoteUrl =
+        'https://user:SOME_TOKEN@claude.mycozy.cloud/data/io.cozy.accounts'
+      mockDatabaseNotFoundOn(
+        'https://claude.mycozy.cloud/data/io.cozy.accounts/_changes?limit=1&descending=true'
+      )
+
+      await expect(fetchRemoteLastSequence(remoteUrl)).rejects.toThrow(
+        DATABASE_NOT_FOUND_ERROR
+      )
+    })
+
+    it('Shoud throw dedicated error when Reserved Doctype error', async () => {
+      const remoteUrl =
+        'https://user:SOME_TOKEN@claude.mycozy.cloud/data/io.cozy.accounts'
+      mockDatabaseReservedDoctypeOn(
+        'https://claude.mycozy.cloud/data/io.cozy.accounts/_changes?limit=1&descending=true'
+      )
+
+      await expect(fetchRemoteLastSequence(remoteUrl)).rejects.toThrow(
+        DATABASE_RESERVED_DOCTYPE_ERROR
+      )
+    })
+  })
+})
+
+const mockDatabaseNotFoundOn = url => {
+  fetch.mockOnceIf(url, JSON.stringify({}), {
+    error: 'not_found',
+    ok: false,
+    reason: 'Database does not exist.',
+    status: 404
+  })
+}
+
+const mockDatabaseReservedDoctypeOn = url => {
+  fetch.mockOnceIf(
+    url,
+    JSON.stringify({
+      error: 'code=403, message=reserved doctype io.cozy.sharings unreadable'
+    }),
+    {
+      ok: false,
+      status: 403
+    }
+  )
+}
+
+const mockUnknownErrorOn = url => {
+  fetch.mockOnceIf(
+    url,
+    JSON.stringify({
+      error: 'code=503, message=SOME UNKNOWN ERROR'
+    }),
+    {
+      ok: false,
+      status: 503
+    }
+  )
+}
+
+const mockDatabaseOn = url => {
+  fetch.mockOnceIf(
+    url,
+    JSON.stringify({
+      last_seq: '97-SOME_SEQ_VALUE',
+      pending: -1,
+      results: [
+        {
+          id: 'SOME_ID',
+          seq: '97-SOME_SEQ_VALUE',
+          doc: null,
+          changes: [{ rev: '3-SOME_REV' }]
+        }
+      ]
+    }),
+    {
+      ok: true,
+      status: 200
+    }
+  )
+}