feat: Improve CozyLink typing and add reset() method

In the Flagship app, we want to be able to reset the local PouchDB
files in order to prevent beta testers to be blocked by an erroneous
Pouch replication

To make this possible we want to expose a public method that resets all
the cozy-client's links

Author: Ldoppea

packages/cozy-client/src/CozyLink.js

@@ -9,13 +9,37 @@ export default class CozyLink {
     }
   }
 
-  request(operation, result, forward) {
+  /**
+   * Request the given operation from the link
+   *
+   * @param {any} operation - The operation to request
+   * @param {any} result - The result from the previous request of the chain
+   * @param {any} forward - The next request of the chain
+   * @returns {Promise<any>}
+   */
+  async request(operation, result, forward) {
     throw new Error('request is not implemented')
   }
 
-  persistCozyData(data, forward) {
+  /**
+   * Persist the given data into the links storage
+   *
+   * @param {any} data - The document to persist
+   * @param {any} forward - The next persistCozyData of the chain
+   * @returns {Promise<any>}
+   */
+  async persistCozyData(data, forward) {
     throw new Error('persistCozyData is not implemented')
   }
+
+  /**
+   * Reset the link data
+   *
+   * @returns {Promise<any>}
+   */
+  async reset() {
+    throw new Error('reset is not implemented')
+  }
 }
 
 const toLink = handler =>

packages/cozy-client/src/FlagshipLink.js

@@ -14,7 +14,7 @@ export default class FlagshipLink extends CozyLink {
     // does nothing, we don't need any client for this kind of link
   }
 
-  reset() {
+  async reset() {
     // does nothing, we don't need any client for this kind of link
   }
 

packages/cozy-client/src/StackLink.js

@@ -80,7 +80,7 @@ export default class StackLink extends CozyLink {
     this.stackClient = client.stackClient || client.client
   }
 
-  reset() {
+  async reset() {
     this.stackClient = null
   }
 

packages/cozy-client/types/CozyLink.d.ts

@@ -1,6 +1,27 @@
 export default class CozyLink {
     constructor(requestHandler: any, persistHandler: any);
-    request(operation: any, result: any, forward: any): void;
-    persistCozyData(data: any, forward: any): void;
+    /**
+     * Request the given operation from the link
+     *
+     * @param {any} operation - The operation to request
+     * @param {any} result - The result from the previous request of the chain
+     * @param {any} forward - The next request of the chain
+     * @returns {Promise<any>}
+     */
+    request(operation: any, result: any, forward: any): Promise<any>;
+    /**
+     * Persist the given data into the links storage
+     *
+     * @param {any} data - The document to persist
+     * @param {any} forward - The next persistCozyData of the chain
+     * @returns {Promise<any>}
+     */
+    persistCozyData(data: any, forward: any): Promise<any>;
+    /**
+     * Reset the link data
+     *
+     * @returns {Promise<any>}
+     */
+    reset(): Promise<any>;
 }
 export function chain(links: any): any;

packages/cozy-client/types/FlagshipLink.d.ts

@@ -8,6 +8,5 @@ export default class FlagshipLink extends CozyLink {
     });
     webviewIntent: import("cozy-intent").WebviewService;
     registerClient(client: any): void;
-    reset(): void;
 }
 import CozyLink from "./CozyLink";

packages/cozy-client/types/StackLink.d.ts

@@ -18,7 +18,6 @@ export default class StackLink extends CozyLink {
     stackClient: any;
     isOnline: any;
     registerClient(client: any): void;
-    reset(): void;
     /**
      *
      * @param {QueryDefinition} query - Query to execute

packages/cozy-pouch-link/types/CozyPouchLink.d.ts

@@ -96,7 +96,6 @@ declare class PouchLink extends CozyLink {
     }): Promise<void>;
     onLogin(): Promise<void>;
     pouches: PouchManager;
-    reset(): Promise<void>;
     /**
      * Receives PouchDB updates (documents grouped by doctype).
      * Normalizes the data (.id -> ._id, .rev -> _rev).