docs: Update types and documentation

cozy · Dec 20, 2024 · 9e0c657 · 9e0c657
1 parent 6aac845
commit 9e0c657
Show file tree

Hide file tree

Showing 10 changed files with 43 additions and 31 deletions.
diff --git a/docs/api/cozy-client/classes/CozyClient.md b/docs/api/cozy-client/classes/CozyClient.md
@@ -1564,13 +1564,14 @@ Contains the fetched token and the client information.
 
 ### requestMutation
 
-▸ **requestMutation**(`definition`): `any`
+▸ **requestMutation**(`definition`, `options`): `any`
 
 *Parameters*
 
 | Name | Type |
 | :------ | :------ |
 | `definition` | `any` |
+| `options` | `any` |
 
 *Returns*
 

diff --git a/docs/api/cozy-client/classes/CozyLink.md b/docs/api/cozy-client/classes/CozyLink.md
@@ -48,13 +48,13 @@ Persist the given data into the links storage
 
 *Defined in*
 
-[packages/cozy-client/src/CozyLink.js:31](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/CozyLink.js#L31)
+[packages/cozy-client/src/CozyLink.js:32](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/CozyLink.js#L32)
 
 ***
 
 ### request
 
-▸ **request**(`operation`, `result`, `forward`): `Promise`<`any`>
+▸ **request**(`operation`, `options`, `result`, `forward`): `Promise`<`any`>
 
 Request the given operation from the link
 
@@ -63,6 +63,7 @@ Request the given operation from the link
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `operation` | `any` | The operation to request |
+| `options` | `any` | The request options |
 | `result` | `any` | The result from the previous request of the chain |
 | `forward` | `any` | The next request of the chain |
 
@@ -72,7 +73,7 @@ Request the given operation from the link
 
 *Defined in*
 
-[packages/cozy-client/src/CozyLink.js:20](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/CozyLink.js#L20)
+[packages/cozy-client/src/CozyLink.js:21](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/CozyLink.js#L21)
 
 ***
 
@@ -88,4 +89,4 @@ Reset the link data
 
 *Defined in*
 
-[packages/cozy-client/src/CozyLink.js:40](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/CozyLink.js#L40)
+[packages/cozy-client/src/CozyLink.js:41](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/CozyLink.js#L41)
diff --git a/docs/api/cozy-client/classes/StackLink.md b/docs/api/cozy-client/classes/StackLink.md
@@ -64,13 +64,14 @@ Transfers queries and mutations to a remote stack
 
 ### executeMutation
 
-▸ **executeMutation**(`mutation`, `result`, `forward`): `Promise`<`any`>
+▸ **executeMutation**(`mutation`, `options`, `result`, `forward`): `Promise`<`any`>
 
 *Parameters*
 
 | Name | Type |
 | :------ | :------ |
 | `mutation` | `any` |
+| `options` | `any` |
 | `result` | `any` |
 | `forward` | `any` |
 
@@ -153,7 +154,7 @@ Persist the given data into the links storage
 
 ### request
 
-▸ **request**(`operation`, `result`, `forward`): `Promise`<`any`>
+▸ **request**(`operation`, `options`, `result`, `forward`): `Promise`<`any`>
 
 Request the given operation from the link
 
@@ -162,6 +163,7 @@ Request the given operation from the link
 | Name | Type |
 | :------ | :------ |
 | `operation` | `any` |
+| `options` | `any` |
 | `result` | `any` |
 | `forward` | `any` |
 

diff --git a/docs/api/cozy-client/classes/WebFlagshipLink.md b/docs/api/cozy-client/classes/WebFlagshipLink.md
@@ -90,7 +90,7 @@ Persist the given data into the links storage
 
 ### request
 
-▸ **request**(`operation`, `result`, `forward`): `Promise`<`boolean`>
+▸ **request**(`operation`, `options`, `result`, `forward`): `Promise`<`boolean`>
 
 Request the given operation from the link
 
@@ -99,6 +99,7 @@ Request the given operation from the link
 | Name | Type |
 | :------ | :------ |
 | `operation` | `any` |
+| `options` | `any` |
 | `result` | `any` |
 | `forward` | `any` |
 

diff --git a/docs/api/cozy-pouch-link/classes/PouchLink.md b/docs/api/cozy-pouch-link/classes/PouchLink.md
@@ -162,7 +162,7 @@ CozyLink.constructor
 
 *Defined in*
 
-[CozyPouchLink.js:833](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L833)
+[CozyPouchLink.js:837](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L837)
 
 ***
 
@@ -182,7 +182,7 @@ CozyLink.constructor
 
 *Defined in*
 
-[CozyPouchLink.js:794](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L794)
+[CozyPouchLink.js:798](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L798)
 
 ***
 
@@ -208,7 +208,7 @@ Create the PouchDB index if not existing
 
 *Defined in*
 
-[CozyPouchLink.js:599](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L599)
+[CozyPouchLink.js:603](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L603)
 
 ***
 
@@ -229,7 +229,7 @@ Create the PouchDB index if not existing
 
 *Defined in*
 
-[CozyPouchLink.js:837](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L837)
+[CozyPouchLink.js:841](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L841)
 
 ***
 
@@ -249,19 +249,20 @@ Create the PouchDB index if not existing
 
 *Defined in*
 
-[CozyPouchLink.js:822](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L822)
+[CozyPouchLink.js:826](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L826)
 
 ***
 
 ### executeMutation
 
-▸ **executeMutation**(`mutation`, `result`, `forward`): `Promise`<`any`>
+▸ **executeMutation**(`mutation`, `options`, `result`, `forward`): `Promise`<`any`>
 
 *Parameters*
 
 | Name | Type |
 | :------ | :------ |
 | `mutation` | `any` |
+| `options` | `any` |
 | `result` | `any` |
 | `forward` | `any` |
 
@@ -271,7 +272,7 @@ Create the PouchDB index if not existing
 
 *Defined in*
 
-[CozyPouchLink.js:756](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L756)
+[CozyPouchLink.js:760](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L760)
 
 ***
 
@@ -291,7 +292,7 @@ Create the PouchDB index if not existing
 
 *Defined in*
 
-[CozyPouchLink.js:676](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L676)
+[CozyPouchLink.js:680](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L680)
 
 ***
 
@@ -315,7 +316,7 @@ Retrieve the PouchDB index if exist, undefined otherwise
 
 *Defined in*
 
-[CozyPouchLink.js:623](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L623)
+[CozyPouchLink.js:627](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L627)
 
 ***
 
@@ -341,7 +342,7 @@ The changes
 
 *Defined in*
 
-[CozyPouchLink.js:469](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L469)
+[CozyPouchLink.js:473](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L473)
 
 ***
 
@@ -366,7 +367,7 @@ The db info
 
 *Defined in*
 
-[CozyPouchLink.js:484](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L484)
+[CozyPouchLink.js:488](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L488)
 
 ***
 
@@ -512,7 +513,7 @@ Emits an event (pouchlink:sync:end) when the sync (all doctypes) is done
 
 *Defined in*
 
-[CozyPouchLink.js:585](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L585)
+[CozyPouchLink.js:589](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L589)
 
 ***
 
@@ -567,7 +568,7 @@ the need to wait for the warmup
 
 *Defined in*
 
-[CozyPouchLink.js:571](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L571)
+[CozyPouchLink.js:575](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L575)
 
 ***
 
@@ -626,7 +627,7 @@ CozyLink.persistCozyData
 
 *Defined in*
 
-[CozyPouchLink.js:519](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L519)
+[CozyPouchLink.js:523](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L523)
 
 ***
 
@@ -652,13 +653,14 @@ CozyLink.persistCozyData
 
 ### request
 
-▸ **request**(`operation`, `result?`, `forward?`): `Promise`<`any`>
+▸ **request**(`operation`, `options`, `result?`, `forward?`): `Promise`<`any`>
 
 *Parameters*
 
 | Name | Type | Default value |
 | :------ | :------ | :------ |
 | `operation` | `any` | `undefined` |
+| `options` | `any` | `undefined` |
 | `result` | `any` | `null` |
 | `forward` | (`operation`: `any`, `result`: `any`) => `void` | `doNothing` |
 
@@ -710,7 +712,7 @@ CozyLink.reset
 
 *Defined in*
 
-[CozyPouchLink.js:492](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L492)
+[CozyPouchLink.js:496](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L496)
 
 ***
 
@@ -800,7 +802,7 @@ Emits pouchlink:sync:stop event
 
 *Defined in*
 
-[CozyPouchLink.js:867](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L867)
+[CozyPouchLink.js:871](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L871)
 
 ***
 
@@ -820,7 +822,7 @@ Emits pouchlink:sync:stop event
 
 *Defined in*
 
-[CozyPouchLink.js:799](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L799)
+[CozyPouchLink.js:803](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L803)
 
 ***
 
@@ -840,7 +842,7 @@ Emits pouchlink:sync:stop event
 
 *Defined in*
 
-[CozyPouchLink.js:804](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L804)
+[CozyPouchLink.js:808](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L808)
 
 ***
 

diff --git a/packages/cozy-client/types/CozyClient.d.ts b/packages/cozy-client/types/CozyClient.d.ts
@@ -535,7 +535,7 @@ declare class CozyClient {
      * @private
      */
     private fetchRelationships;
-    requestMutation(definition: any): any;
+    requestMutation(definition: any, options: any): any;
     getIncludesRelationships(queryDefinition: any): import("lodash").Dictionary<any>;
     /**
      * Returns documents with their relationships resolved according to their schema.

diff --git a/packages/cozy-client/types/CozyLink.d.ts b/packages/cozy-client/types/CozyLink.d.ts
@@ -4,11 +4,12 @@ export default class CozyLink {
      * Request the given operation from the link
      *
      * @param {any} operation - The operation to request
+     * @param {any} options - The request options
      * @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>;
+    request(operation: any, options: any, result: any, forward: any): Promise<any>;
     /**
      * Persist the given data into the links storage
      *

diff --git a/packages/cozy-client/types/StackLink.d.ts b/packages/cozy-client/types/StackLink.d.ts
@@ -27,7 +27,7 @@ export default class StackLink extends CozyLink {
      * @returns {Promise<import("./types").ClientResponse>}
      */
     executeQuery(query: QueryDefinition): Promise<import("./types").ClientResponse>;
-    executeMutation(mutation: any, result: any, forward: any): Promise<any>;
+    executeMutation(mutation: any, options: any, result: any, forward: any): Promise<any>;
 }
 export type StackLinkOptions = {
     /**

diff --git a/packages/cozy-client/types/types.d.ts b/packages/cozy-client/types/types.d.ts
@@ -553,6 +553,10 @@ export type QueryOptions = {
      * - If set to true, the query will be run directly on the current store's state
      */
     executeFromStore?: boolean;
+    /**
+     * - If set to true, the query will be executed through StackLink only even if there are other links available
+     */
+    forceStack?: boolean;
 };
 export type Query = {
     definition: QueryDefinition;

diff --git a/packages/cozy-pouch-link/types/CozyPouchLink.d.ts b/packages/cozy-pouch-link/types/CozyPouchLink.d.ts
@@ -275,7 +275,7 @@ declare class PouchLink extends CozyLink {
         skip: any;
         next: boolean;
     }>;
-    executeMutation(mutation: any, result: any, forward: any): Promise<any>;
+    executeMutation(mutation: any, options: any, result: any, forward: any): Promise<any>;
     createDocument(mutation: any): Promise<any>;
     updateDocument(mutation: any): Promise<any>;
     updateDocuments(mutation: any): Promise<any[]>;