cozy-pouch-link 50.1.0 → 50.3.0

package/dist/CozyPouchLink.js

@@ -43,6 +43,8 @@ var _zipWith = _interopRequireDefault(require("lodash/zipWith"));
 
 var _get = _interopRequireDefault(require("lodash/get"));
 
+var _debounce = _interopRequireDefault(require("lodash/debounce"));
+
 var _helpers = _interopRequireDefault(require("./helpers"));
 
 var _mango = require("./mango");
@@ -92,6 +94,8 @@ var parseMutationResult = function parseMutationResult(original, res) {
 var DEFAULT_OPTIONS = {
   replicationInterval: 30 * 1000
 };
+var DEFAULT_DEBOUNCE_DELAY = 10 * 1000;
+var MAX_DEBOUNCE_DELAY = 600 * 1000;
 
 var addBasicAuth = function addBasicAuth(url, basicAuth) {
   return url.replace('//', "//".concat(basicAuth));
@@ -138,6 +142,8 @@ var normalizeAll = function normalizeAll(client) {
  * @typedef {object} PouchLinkOptions
  * @property {boolean} initialSync Whether or not a replication process should be started. Default is false
  * @property {boolean} periodicSync Whether or not the replication should be periodic. Default is true
+ * @property {number} [syncDebounceDelayInMs] Debounce delay (in ms) when calling `startReplicationWithDebounce()` method. Should be used only when periodicSync is false. Default is 10 seconds
+ * @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 {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")
@@ -172,7 +178,9 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
     var doctypes = options.doctypes,
         doctypesReplicationOptions = options.doctypesReplicationOptions,
         periodicSync = options.periodicSync,
-        initialSync = options.initialSync;
+        initialSync = options.initialSync,
+        syncDebounceDelayInMs = options.syncDebounceDelayInMs,
+        syncDebounceMaxDelayInMs = options.syncDebounceMaxDelayInMs;
     _this.options = options;
 
     if (!doctypes) {
@@ -188,6 +196,11 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
     /** @type {Record<string, ReplicationStatus>} - Stores replication states per doctype */
 
     _this.replicationStatus = _this.replicationStatus || {};
+    /** @private */
+
+    _this.startReplicationDebounced = (0, _debounce.default)(_this._startReplication, syncDebounceDelayInMs || DEFAULT_DEBOUNCE_DELAY, {
+      maxWait: syncDebounceMaxDelayInMs || MAX_DEBOUNCE_DELAY
+    });
     return _this;
   }
   /**
@@ -519,6 +532,25 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
       this.replicationStatus[doctype] = 'idle';
       this.client.emit('pouchlink:doctypesync:end', doctype);
     }
+    /**
+     * @private
+     */
+
+  }, {
+    key: "_startReplication",
+    value: function _startReplication() {
+      this.client.emit('pouchlink:sync:start');
+
+      if (this.periodicSync) {
+        this.pouches.startReplicationLoop();
+      } else {
+        this.pouches.replicateOnce();
+      }
+
+      if (this.options.onStartReplication) {
+        this.options.onStartReplication.apply(this);
+      }
+    }
     /**
      * User of the link can call this to start ongoing replications.
      * Typically, it can be used when the application regains focus.
@@ -532,17 +564,26 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
   }, {
     key: "startReplication",
     value: function startReplication() {
-      this.client.emit('pouchlink:sync:start');
+      this.startReplicationDebounced.cancel();
+      return this._startReplication();
+    }
+    /**
+     * Debounced version of startReplication() method
+     *
+     * Debounce delay can be configured through constructor's `syncDebounceDelayInMs` option
+     *
+     * @public
+     * @returns {void}
+     */
 
+  }, {
+    key: "startReplicationWithDebounce",
+    value: function startReplicationWithDebounce() {
       if (this.periodicSync) {
-        this.pouches.startReplicationLoop();
-      } else {
-        this.pouches.replicateOnce();
+        throw new Error('createDebounceableReplication cannot be called when periodic sync is configured');
       }
 
-      if (this.options.onStartReplication) {
-        this.options.onStartReplication.apply(this);
-      }
+      return this.startReplicationDebounced();
     }
     /**
      * User of the link can call this to stop ongoing replications.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-pouch-link",
-  "version": "50.1.0",
+  "version": "50.3.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": "^50.1.0",
+    "cozy-client": "^50.2.0",
     "pouchdb-browser": "^7.2.2",
     "pouchdb-find": "^7.2.2"
   },
@@ -39,5 +39,5 @@
     "typecheck": "tsc -p tsconfig.json"
   },
   "sideEffects": false,
-  "gitHead": "eabd164250195c878b7f40fb22c41e8b89503ea2"
+  "gitHead": "6681e9a57350fd3480c1b9167f3dad5988c12456"
 }

package/types/CozyPouchLink.d.ts

@@ -12,6 +12,14 @@ export type PouchLinkOptions = {
      * Whether or not the replication should be periodic. Default is true
      */
     periodicSync: boolean;
+    /**
+     * Debounce delay (in ms) when calling `startReplicationWithDebounce()` method. Should be used only when periodicSync is false. Default is 10 seconds
+     */
+    syncDebounceDelayInMs?: number;
+    /**
+     * The maximum duration (in ms) the `startReplicationWithDebounce()` method can be delayed. Should be used only when periodicSync is false. Default is 10 minutes
+     */
+    syncDebounceMaxDelayInMs?: number;
     /**
      * Milliseconds between periodic replications
      */
@@ -38,6 +46,8 @@ export type PouchLinkOptions = {
  * @typedef {object} PouchLinkOptions
  * @property {boolean} initialSync Whether or not a replication process should be started. Default is false
  * @property {boolean} periodicSync Whether or not the replication should be periodic. Default is true
+ * @property {number} [syncDebounceDelayInMs] Debounce delay (in ms) when calling `startReplicationWithDebounce()` method. Should be used only when periodicSync is false. Default is 10 seconds
+ * @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 {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")
@@ -74,6 +84,8 @@ declare class PouchLink extends CozyLink {
     periodicSync: boolean;
     /** @type {Record<string, ReplicationStatus>} - Stores replication states per doctype */
     replicationStatus: Record<string, ReplicationStatus>;
+    /** @private */
+    private startReplicationDebounced;
     getReplicationURL(doctype: any): string;
     registerClient(client: any): Promise<void>;
     client: any;
@@ -118,6 +130,10 @@ declare class PouchLink extends CozyLink {
     handleOnSync(doctypeUpdates: any): void;
     handleDoctypeSyncStart(doctype: any): void;
     handleDoctypeSyncEnd(doctype: any): void;
+    /**
+     * @private
+     */
+    private _startReplication;
     /**
      * User of the link can call this to start ongoing replications.
      * Typically, it can be used when the application regains focus.
@@ -128,6 +144,15 @@ declare class PouchLink extends CozyLink {
      * @returns {void}
      */
     public startReplication(): void;
+    /**
+     * Debounced version of startReplication() method
+     *
+     * Debounce delay can be configured through constructor's `syncDebounceDelayInMs` option
+     *
+     * @public
+     * @returns {void}
+     */
+    public startReplicationWithDebounce(): void;
     /**
      * User of the link can call this to stop ongoing replications.
      * Typically, it can be used when the applications loses focus.