cozy-pouch-link 49.6.1 → 49.7.1

package/dist/CozyPouchLink.js

@@ -136,7 +136,9 @@ var normalizeAll = function normalizeAll(client) {
 
 /**
  * @typedef {object} PouchLinkOptions
- * @property {number} [replicationInterval] Milliseconds between replications
+ * @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} [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")
  * @property {import('./types').LinkPlatform} platform Platform specific adapters and methods
@@ -168,7 +170,9 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
     var options = (0, _defaults.default)({}, opts, DEFAULT_OPTIONS);
     _this = _super.call(this, options);
     var doctypes = options.doctypes,
-        doctypesReplicationOptions = options.doctypesReplicationOptions;
+        doctypesReplicationOptions = options.doctypesReplicationOptions,
+        periodicSync = options.periodicSync,
+        initialSync = options.initialSync;
     _this.options = options;
 
     if (!doctypes) {
@@ -179,6 +183,8 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
     _this.doctypesReplicationOptions = doctypesReplicationOptions;
     _this.indexes = {};
     _this.storage = new _localStorage.PouchLocalStorage(((_options$platform = options.platform) === null || _options$platform === void 0 ? void 0 : _options$platform.storage) || _platformWeb.platformWeb.storage);
+    _this.initialSync = initialSync !== null && initialSync !== void 0 ? initialSync : false;
+    _this.periodicSync = periodicSync !== null && periodicSync !== void 0 ? periodicSync : true;
     /** @type {Record<string, ReplicationStatus>} - Stores replication states per doctype */
 
     _this.replicationStatus = _this.replicationStatus || {};
@@ -422,7 +428,7 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
                 return this.pouches.init();
 
               case 27:
-                if (this.client && this.options.initialSync) {
+                if (this.client && this.initialSync) {
                   this.startReplication();
                 }
 
@@ -527,7 +533,12 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
     key: "startReplication",
     value: function startReplication() {
       this.client.emit('pouchlink:sync:start');
-      this.pouches.startReplicationLoop();
+
+      if (this.periodicSync) {
+        this.pouches.startReplicationLoop();
+      } else {
+        this.pouches.replicateOnce();
+      }
 
       if (this.options.onStartReplication) {
         this.options.onStartReplication.apply(this);

package/dist/types.js

@@ -79,23 +79,23 @@ exports.default = void 0;
 
 /**
  * @typedef {object} PouchDBInfo
- * @param {string} db_name - The database name
- * @param {number} doc_count - The number of doc in the database
- * @param {number} update_seq - The sequence number
+ * @property {string} db_name - The database name
+ * @property {number} doc_count - The number of doc in the database
+ * @property {number} update_seq - The sequence number
  */
 
 /**
  * @typedef {object} PouchDBChangesResults
- * @param {Array<PouchDBChanges>} results - The changes results
- * @param {number} last_seq - The last sequence number
+ * @property {Array<PouchDBChanges>} results - The changes results
+ * @property {number} last_seq - The last sequence number
  */
 
 /**
  * @typedef {object} PouchDBChanges
- * @param {string} id - The doc id
- * @param {boolean} deleted - Whether or not the change is a deleted doc
- * @param {Array<object>} changes - The list of changes revisions
- * @param {object} doc - The changed doc
+ * @property {string} id - The doc id
+ * @property {boolean} deleted - Whether or not the change is a deleted doc
+ * @property {Array<object>} changes - The list of changes revisions
+ * @property {object} doc - The changed doc
  */
 var _default = {};
 exports.default = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-pouch-link",
-  "version": "49.6.1",
+  "version": "49.7.1",
   "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": "^49.6.0",
+    "cozy-client": "^49.7.1",
     "pouchdb-browser": "^7.2.2",
     "pouchdb-find": "^7.2.2"
   },
@@ -39,5 +39,5 @@
     "typecheck": "tsc -p tsconfig.json"
   },
   "sideEffects": false,
-  "gitHead": "b4ca0cc319d1aacb9d1e286a13240055d1ab68d3"
+  "gitHead": "0cb890e76b0cf5e17c698d84d20248486baed312"
 }

package/types/CozyPouchLink.d.ts

@@ -5,7 +5,15 @@ export type CozyClientDocument = any;
 export type ReplicationStatus = "idle" | "replicating";
 export type PouchLinkOptions = {
     /**
-     * Milliseconds between replications
+     * Whether or not a replication process should be started. Default is false
+     */
+    initialSync: boolean;
+    /**
+     * Whether or not the replication should be periodic. Default is true
+     */
+    periodicSync: boolean;
+    /**
+     * Milliseconds between periodic replications
      */
     replicationInterval?: number;
     /**
@@ -28,7 +36,9 @@ export type PouchLinkOptions = {
  */
 /**
  * @typedef {object} PouchLinkOptions
- * @property {number} [replicationInterval] Milliseconds between replications
+ * @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} [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")
  * @property {import('./types').LinkPlatform} platform Platform specific adapters and methods
@@ -60,6 +70,8 @@ declare class PouchLink extends CozyLink {
     doctypesReplicationOptions: Record<string, any>;
     indexes: {};
     storage: PouchLocalStorage;
+    initialSync: boolean;
+    periodicSync: boolean;
     /** @type {Record<string, ReplicationStatus>} - Stores replication states per doctype */
     replicationStatus: Record<string, ReplicationStatus>;
     getReplicationURL(doctype: any): string;

package/types/types.d.ts

@@ -102,6 +102,45 @@ export type PouchDbIndex = {
      */
     result: 'exists' | 'created';
 };
-export type PouchDBInfo = any;
-export type PouchDBChangesResults = any;
-export type PouchDBChanges = any;
+export type PouchDBInfo = {
+    /**
+     * - The database name
+     */
+    db_name: string;
+    /**
+     * - The number of doc in the database
+     */
+    doc_count: number;
+    /**
+     * - The sequence number
+     */
+    update_seq: number;
+};
+export type PouchDBChangesResults = {
+    /**
+     * - The changes results
+     */
+    results: Array<PouchDBChanges>;
+    /**
+     * - The last sequence number
+     */
+    last_seq: number;
+};
+export type PouchDBChanges = {
+    /**
+     * - The doc id
+     */
+    id: string;
+    /**
+     * - Whether or not the change is a deleted doc
+     */
+    deleted: boolean;
+    /**
+     * - The list of changes revisions
+     */
+    changes: Array<object>;
+    /**
+     * - The changed doc
+     */
+    doc: object;
+};