cozy-client 33.0.1 → 33.0.2

package/dist/CozyClient.js

@@ -2636,7 +2636,7 @@ var CozyClient = /*#__PURE__*/function () {
 CozyClient.hooks = CozyClient.hooks || {};
 CozyClient.fetchPolicies = _policies.default; //COZY_CLIENT_VERSION_PACKAGE in replaced by babel. See babel config
 
-CozyClient.version = "33.0.1";
+CozyClient.version = "33.0.2";
 
 _microee.default.mixin(CozyClient);
 

package/dist/models/file.js

@@ -100,8 +100,10 @@ var isDirectory = function isDirectory(file) {
   return file && file.type === DIR_TYPE;
 };
 /**
+ * Is file param a correct note
  *
  * @param {IOCozyFile} file io.cozy.files
+ * @returns {boolean}
  */
 
 

package/dist/types.js

@@ -163,12 +163,28 @@ var _dsl = require("./queries/dsl");
  * @property {object} [cozyMetadata] - Cozy Metadata
  */
 
+/**
+ * Metadata on io.cozy.files documents
+ *
+ * This is a first step, to continue
+ *
+ * Filled according to:
+ * https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.files_metadata/
+ * https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.notes/
+ *
+ * @typedef {object} FileMetadata - A io.cozy.files document's metadata
+ * @property {object} [content] - The Note's content. See https://prosemirror.net/docs/ref/#model for more informations
+ * @property {object} [schema] - the schema used by prosemirror (with notes and marks serialized as arrays to preserve the order).
+ * @property {string} [title] - the initial title of the note (that will also be used for the file name)
+ * @property {number} [version] - Number of a note
+ */
+
 /**
  * @typedef {object} FileDocument - An io.cozy.files document
  * @property {string} _id - Id of the file
  * @property {FilesDoctype} _type - Doctype of the file
  * @property {string} name - Name of the file
- * @property {object} metadata - Metadata of the file
+ * @property {FileMetadata} metadata - Metadata of the file
  * @property {string} type - Type of the file
  * @property {string} class - Class of the file
  * @property {string} mime - Mime of the file

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "33.0.1",
+  "version": "33.0.2",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -73,5 +73,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "4314ca7d19acb10bf4bb153e14f9152c32c8e0ff"
+  "gitHead": "c00ba115384a2ba0f562adb4fa5e141ea64dbe45"
 }

package/types/types.d.ts

@@ -174,6 +174,27 @@ export type CozyClientDocument = {
      */
     cozyMetadata?: object;
 };
+/**
+ * - A io.cozy.files document's metadata
+ */
+export type FileMetadata = {
+    /**
+     * - The Note's content. See https://prosemirror.net/docs/ref/#model for more informations
+     */
+    content?: object;
+    /**
+     * - the schema used by prosemirror (with notes and marks serialized as arrays to preserve the order).
+     */
+    schema?: object;
+    /**
+     * - the initial title of the note (that will also be used for the file name)
+     */
+    title?: string;
+    /**
+     * - Number of a note
+     */
+    version?: number;
+};
 /**
  * - An io.cozy.files document
  */
@@ -193,7 +214,7 @@ export type FileDocument = {
     /**
      * - Metadata of the file
      */
-    metadata: object;
+    metadata: FileMetadata;
     /**
      * - Type of the file
      */