[VO-711] feat: Add a collection to access files into a Nextcloud

docs/api/cozy-client/README.md

@@ -894,7 +894,7 @@ Fetches a queryDefinition and returns the queryState
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `queryDefinition` | [`QueryDefinition`](classes/QueryDefinition.md) | Definition created with Q() |
+| `queryDefinition` | [`QueryDefinition`](classes/QueryDefinition.md) | () => [`QueryDefinition`](classes/QueryDefinition.md) | Definition created with Q() |
 | `options` | `QueryOptions` | Options created with Q() |
 
 *Returns*

docs/api/cozy-stack-client.md

@@ -108,6 +108,9 @@ query to work</p>
 <dd><p>Rules determine the behavior of the sharing when changes are made to the shared document
 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="#forceDownload">forceDownload</a></dt>
+<dd><p>Force a download from the given href</p>
+</dd>
 </dl>
 
 ## Functions
@@ -2200,6 +2203,18 @@ See https://docs.cozy.io/en/cozy-stack/sharing-design/#description-of-a-sharing
 | document | [<code>Sharing</code>](#Sharing) | The document to share. Should have and _id and a name |
 | sharingType | [<code>SharingType</code>](#SharingType) | The type of the sharing |
 
+<a name="forceDownload"></a>
+
+## forceDownload
+Force a download from the given href
+
+**Kind**: global constant  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| href | <code>string</code> | The link to download |
+| filename | <code>string</code> | The file name to download |
+
 <a name="getAccessToken"></a>
 
 ## getAccessToken() ⇒ <code>string</code>

packages/cozy-client/src/hooks/useQuery.js

@@ -21,7 +21,7 @@ const generateFetchMoreQueryDefinition = queryResult => {
 /**
  * Fetches a queryDefinition and returns the queryState
  *
- * @param {QueryDefinition} queryDefinition - Definition created with Q()
+ * @param {QueryDefinition|(() => QueryDefinition)} queryDefinition - Definition created with Q()
  * @param {import("../types").QueryOptions} options - Options created with Q()
  * @returns {import("../types").UseQueryReturnValue}
  */
@@ -51,7 +51,7 @@ const useQuery = (queryDefinition, options) => {
 
   const client = useClient()
   const queryState = useSelector(() => {
-    if (options.singleDocData === undefined && queryDefinition.id) {
+    if (options.singleDocData === undefined && definition?.id) {
       logger.warn(
         'useQuery options.singleDocData will pass to true in a next version of cozy-client, please add it now to prevent any problem in the future.'
       )

packages/cozy-client/types/hooks/useQuery.d.ts

@@ -3,9 +3,9 @@ export default useQuery;
 /**
  * Fetches a queryDefinition and returns the queryState
  *
- * @param {QueryDefinition} queryDefinition - Definition created with Q()
+ * @param {QueryDefinition|(() => QueryDefinition)} queryDefinition - Definition created with Q()
  * @param {import("../types").QueryOptions} options - Options created with Q()
  * @returns {import("../types").UseQueryReturnValue}
  */
-declare function useQuery(queryDefinition: QueryDefinition, options: import("../types").QueryOptions): import("../types").UseQueryReturnValue;
+declare function useQuery(queryDefinition: QueryDefinition | (() => QueryDefinition), options: import("../types").QueryOptions): import("../types").UseQueryReturnValue;
 import { QueryDefinition } from "../queries/dsl";

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

@@ -26,6 +26,10 @@ import MicroEE from 'microee'
 import errors, { FetchError } from './errors'
 import logger from './logger'
 import PromiseCache from './promise-cache'
+import {
+  NEXTCLOUD_FILES_DOCTYPE,
+  NextcloudFilesCollection
+} from './NextcloudFilesCollection'
 
 const normalizeUri = uriArg => {
   let uri = uriArg
@@ -100,6 +104,8 @@ class CozyStackClient {
         return new ShortcutsCollection(this)
       case APPS_REGISTRY_DOCTYPE:
         return new AppsRegistryCollection(this)
+      case NEXTCLOUD_FILES_DOCTYPE:
+        return new NextcloudFilesCollection(this)
       default:
         return new DocumentCollection(doctype, this)
     }

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

@@ -6,7 +6,7 @@ import pick from 'lodash/pick'
 import { MangoQueryOptions } from './mangoIndex'
 
 import DocumentCollection, { normalizeDoc } from './DocumentCollection'
-import { uri, slugify, formatBytes } from './utils'
+import { uri, slugify, formatBytes, forceDownload } from './utils'
 import { FetchError } from './errors'
 import { dontThrowNotFoundError } from './Collection'
 import { getIllegalCharacters } from './getIllegalCharacter'
@@ -659,13 +659,7 @@ class FileCollection extends DocumentCollection {
    * @param {string} filename - The file name to download
    */
   forceFileDownload = (href, filename) => {
-    const element = document.createElement('a')
-    element.setAttribute('href', href)
-    element.setAttribute('download', filename)
-    element.style.display = 'none'
-    document.body.appendChild(element)
-    element.click()
-    document.body.removeChild(element)
+    forceDownload(href, filename)
   }
 
   /**

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

@@ -0,0 +1,62 @@
+import DocumentCollection from './DocumentCollection'
+import { forceDownload } from './utils'
+
+const NEXTCLOUD_FILES_DOCTYPE = 'io.cozy.remote.nextcloud.files'
+
+const normalizeDoc = DocumentCollection.normalizeDoctypeJsonApi(
+  NEXTCLOUD_FILES_DOCTYPE
+)
+const normalizeNextcloudFile = (sourceAccount, path) => file => {
+  const extendedAttributes = {
+    ...file.attributes,
+    path: `${path}${path.endsWith('/') ? '' : '/'}${file.attributes.name}`,
+    cozyMetadata: {
+      ...file.attributes.cozyMetadata,
+      sourceAccount
+    }
+  }
+
+  return {
+    ...normalizeDoc(file, NEXTCLOUD_FILES_DOCTYPE),
+    ...extendedAttributes
+  }
+}
+
+class NextcloudFilesCollection extends DocumentCollection {
+  constructor(stackClient) {
+    super(NEXTCLOUD_FILES_DOCTYPE, stackClient)
+  }
+
+  async find(selector) {
+    if (selector.sourceAccount && selector.path) {
+      const resp = await this.stackClient.fetchJSON(
+        'GET',
+        `/remote/nextcloud/${selector.sourceAccount}/${selector.path}`
+      )
+
+      return {
+        data: resp.data.map(
+          normalizeNextcloudFile(selector.sourceAccount, selector.path)
+        )
+      }
+    }
+    throw new Error('Not implemented')
+  }
+
+  /**
+   * Download a file from a Nextcloud server
+   *
+   */
+  async download(file) {
+    const res = await this.stackClient.fetch(
+      'GET',
+      `/remote/nextcloud/${file.cozyMetadata.sourceAccount}/${file.path}?Dl=1`
+    )
+    const blob = await res.blob()
+    const href = URL.createObjectURL(blob)
+    const filename = file.path.split('/').pop()
+    forceDownload(href, filename)
+  }
+}
+
+export { NextcloudFilesCollection, NEXTCLOUD_FILES_DOCTYPE }

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

@@ -69,3 +69,19 @@ export const formatBytes = (bytes, decimals = 2) => {
 
   return parseFloat((bytes / Math.pow(k, i)).toFixed(dm)) + ' ' + sizes[i]
 }
+
+/**
+ * Force a download from the given href
+ *
+ * @param {string} href - The link to download
+ * @param {string} filename - The file name to download
+ */
+export const forceDownload = (href, filename) => {
+  const element = document.createElement('a')
+  element.setAttribute('href', href)
+  element.setAttribute('download', filename)
+  element.style.display = 'none'
+  document.body.appendChild(element)
+  element.click()
+  document.body.removeChild(element)
+}