cozy-client 27.3.2 → 27.6.0

package/types/types.d.ts

@@ -64,24 +64,47 @@ export type QueryOptions = {
      * - Does not seem to be used
      */
     update?: string;
+    /**
+     * - Callback when the query is errored
+     */
+    onError?: Function;
 };
 export type FetchMoreAble = {
     fetchMore: Function;
 };
 export type UseQueryReturnValue = QueryState & FetchMoreAble;
 /**
- * A reference to a document (special case of a relationship used between photos and albums)
+ * A reference to a document
+ */
+export type ReferencedByRelationship = {
+    parent?: RelationshipParent;
+    referenced_by?: ReferencedBy;
+};
+export type RelationshipParent = {
+    links: {
+        related: string;
+    };
+    data?: Reference;
+};
+export type ReferencedBy = {
+    links: {
+        self: string;
+    };
+    data: Reference[] | null;
+};
+/**
+ * A reference to a document
  * https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.files/#references
  */
 export type Reference = {
     /**
      * - id of the document
      */
-    _id: string;
+    id: string;
     /**
      * - doctype of the document
      */
-    _type: string;
+    type: string;
 };
 export type ReferenceMap = {
     [x: string]: Reference[];
@@ -118,7 +141,11 @@ export type CozyClientDocument = {
     /**
      * - Relationships of the document
      */
-    relationships?: object;
+    relationships?: ReferencedByRelationship;
+    /**
+     * - referenced by of another document
+     */
+    referenced_by?: Reference[];
 };
 /**
  * - An io.cozy.files document