feat: Update file metadata types

This commit takes into account the decision on the metadata format for shortcuts taken as part of this PR : cozy/cozy-doctypes#268
cozy · Sep 23, 2024 · fb1bbf0 · fb1bbf0
1 parent 86377c2
commit fb1bbf0
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/packages/cozy-client/src/types.js b/packages/cozy-client/src/types.js
@@ -452,6 +452,12 @@ import { QueryDefinition } from './queries/dsl'
  * @property {string} [noticePeriod] - Notice period of the paper, in days
  * @property {string} [datetime] - Image EXIF date, if relevant
  * @property {string} [instanceName] - Name of the instance
+ * @property {object} [target] - Information of the target of the shortcut
+ * @property {string} [target.title] - The title of the application to which the shortcut redirects
+ * @property {string} [target.description] - A brief description of the application
+ * @property {string} [target.category] - The category of the application
+ * @property {object} [externalDataSource] - Additional information to maintain link with external data source
+ * @property {string} [externalDataSource.source] - The space to which the application belongs
  */
 
 /**

diff --git a/packages/cozy-client/types/types.d.ts b/packages/cozy-client/types/types.d.ts
@@ -790,6 +790,20 @@ export type FileMetadata = {
      * - Name of the instance
      */
     instanceName?: string;
+    /**
+     * - Information of the target of the shortcut
+     */
+    target?: {
+        title: string;
+        description: string;
+        category: string;
+    };
+    /**
+     * - Additional information to maintain link with external data source
+     */
+    externalDataSource?: {
+        source: string;
+    };
 };
 /**
  * - An io.cozy.files document