feat: Manage rules for shared drive sharing

Shared drive sharing have special sharing rules.

Author: zatteo

docs/api/cozy-stack-client.md

@@ -171,6 +171,9 @@ CouchDB transforms $nor into $and with $ne operators</p>
 <dt><a href="#getSharingRulesForFile">getSharingRulesForFile(document)</a> ⇒ <code><a href="#Rule">Array.&lt;Rule&gt;</a></code></dt>
 <dd><p>Compute the rules that define how to share a File. See <a href="https://docs.cozy.io/en/cozy-stack/sharing-design/#description-of-a-sharing">https://docs.cozy.io/en/cozy-stack/sharing-design/#description-of-a-sharing</a></p>
 </dd>
+<dt><a href="#getSharingRulesForSharedDrive">getSharingRulesForSharedDrive(document)</a> ⇒ <code><a href="#Rule">Array.&lt;Rule&gt;</a></code></dt>
+<dd><p>Compute the rules that define a shared drive.</p>
+</dd>
 <dt><a href="#getSharingPolicyForFile">getSharingPolicyForFile(document)</a> ⇒ <code><a href="#SharingPolicy">SharingPolicy</a></code></dt>
 <dd><p>Compute the sharing policy for a File based on its sharing type</p>
 </dd>
@@ -268,6 +271,8 @@ not.</p>
 <dt><a href="#Rule">Rule</a> : <code>object</code></dt>
 <dd><p>A sharing rule</p>
 </dd>
+<dt><a href="#SharingRulesOptions">SharingRulesOptions</a> : <code>object</code></dt>
+<dd></dd>
 <dt><a href="#Recipient">Recipient</a> : <code>object</code></dt>
 <dd><p>An io.cozy.contact</p>
 </dd>
@@ -2345,6 +2350,7 @@ See https://docs.cozy.io/en/cozy-stack/sharing-design/#description-of-a-sharing
 | Param | Type | Description |
 | --- | --- | --- |
 | document | [<code>Sharing</code>](#Sharing) | The document to share. Should have and _id and a name |
+| [sharingRulesOptions] | [<code>SharingRulesOptions</code>](#SharingRulesOptions) | The document to share. Should have and _id and a name |
 
 <a name="forceDownload"></a>
 
@@ -2482,6 +2488,18 @@ Compute the rules that define how to share a File. See https://docs.cozy.io/en/c
 | --- | --- | --- |
 | document | [<code>Sharing</code>](#Sharing) | The document to share. Should have and _id and a name |
 
+<a name="getSharingRulesForSharedDrive"></a>
+
+## getSharingRulesForSharedDrive(document) ⇒ [<code>Array.&lt;Rule&gt;</code>](#Rule)
+Compute the rules that define a shared drive.
+
+**Kind**: global function  
+**Returns**: [<code>Array.&lt;Rule&gt;</code>](#Rule) - The rules that define a shared drive  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| document | [<code>Sharing</code>](#Sharing) | The document to share. Should have and _id and a name |
+
 <a name="getSharingPolicyForFile"></a>
 
 ## getSharingPolicyForFile(document) ⇒ [<code>SharingPolicy</code>](#SharingPolicy)
@@ -3100,6 +3118,16 @@ A sharing rule
 | [update] | <code>string</code> | 
 | [remove] | <code>string</code> | 
 
+<a name="SharingRulesOptions"></a>
+
+## SharingRulesOptions : <code>object</code>
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| [sharedDrive] | <code>boolean</code> | 
+
 <a name="Recipient"></a>
 
 ## Recipient : <code>object</code>

packages/cozy-stack-client/src/SharingCollection.js

@@ -19,6 +19,11 @@ const normalizeSharing = normalizeDoctypeJsonApi(SHARING_DOCTYPE)
  * @property {string=} remove
  */
 
+/**
+ * @typedef {object} SharingRulesOptions
+ * @property {boolean} [sharedDrive]
+ */
+
 /**
  * @typedef {object} Recipient An io.cozy.contact
  */
@@ -103,7 +108,7 @@ class SharingCollection extends DocumentCollection {
       description,
       preview_path: previewPath,
       open_sharing: openSharing,
-      rules: rules ? rules : getSharingRules(document)
+      rules: rules ? rules : getSharingRules(document, { sharedDrive })
     }
     let optionalAttributes = {}
     if (appSlug) {
@@ -241,10 +246,17 @@ SharingCollection.normalizeDoctype = normalizeDoctypeJsonApi
  * See https://docs.cozy.io/en/cozy-stack/sharing-design/#description-of-a-sharing
  *
  * @param {Sharing} document - The document to share. Should have and _id and a name
+ * @param {SharingRulesOptions} [sharingRulesOptions] - The document to share. Should have and _id and a name
  *
  * @returns {Array<Rule>=} The rules that define how to share the document
  */
-export const getSharingRules = document => {
+export const getSharingRules = (document, sharingRulesOptions = {}) => {
+  const { sharedDrive } = sharingRulesOptions
+
+  if (sharedDrive) {
+    return getSharingRulesForSharedDrive(document)
+  }
+
   if (isFile(document)) {
     return getSharingRulesForFile(document)
   }
@@ -319,6 +331,27 @@ const getSharingRulesForFile = document => {
   ]
 }
 
+/**
+ * Compute the rules that define a shared drive.
+ *
+ * @param {Sharing} document - The document to share. Should have and _id and a name
+ *
+ * @returns {Array<Rule>=} The rules that define a shared drive
+ */
+const getSharingRulesForSharedDrive = document => {
+  const { _id, name } = document
+  return [
+    {
+      title: name,
+      doctype: 'io.cozy.files',
+      values: [_id],
+      add: 'none',
+      update: 'none',
+      remove: 'none'
+    }
+  ]
+}
+
 /**
  * Compute the sharing policy for a File based on its sharing type
  *