cozy-client 59.4.0 → 60.1.0

package/dist/store.spec.js

@@ -408,7 +408,9 @@ describe('Store', () => {
         hasMore: false,
         count: 0,
         fetchedPagesCount: 0,
-        data: null
+        data: null,
+        storeData: [],
+        relationshipNames: []
       })
     })
 

package/dist/types.js

@@ -276,16 +276,22 @@ var _dsl = require("./queries/dsl");
  * @property {number} fetchedPagesCount
  * @property {string} bookmark
  * @property {object} [execution_stats]
+ * @property {Array<string>} relationshipNames - The relationships names, used to check hydrated documents
  * @property {QueryOptions} [options]
  */
 
 /**
  * @typedef {object} QueryStateData
- * @property {object|Array} data
+ * @property {object|Array} data - Collection of hydrated documents
  */
 
 /**
- * @typedef {QueryStateWithoutData & QueryStateData} QueryState
+ * @typedef {object} QueryStateStoreData
+ * @property {object|Array} storeData - Collection of store's documents
+ */
+
+/**
+ * @typedef {QueryStateWithoutData & QueryStateData & QueryStateStoreData} QueryState
  */
 
 /**
@@ -458,6 +464,7 @@ var _dsl = require("./queries/dsl");
  * @property {CozyMetadata} [cozyMetadata] - Cozy Metadata
  * @property {CozyClientDocumentMeta} [meta] - Pouch Metadata
  * @property {boolean} [cozyLocalOnly] - When true the document should NOT be replicated to the remote database
+ * @property {string} [driveId] - Id of a shared drive, only for shared io.cozy.files
  */
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "59.4.0",
+  "version": "60.1.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -19,7 +19,7 @@
     "@types/jest": "^26.0.20",
     "@types/lodash": "^4.14.170",
     "btoa": "^1.2.1",
-    "cozy-stack-client": "^59.4.0",
+    "cozy-stack-client": "^60.1.0",
     "date-fns": "2.29.3",
     "fast-deep-equal": "^3.1.3",
     "json-stable-stringify": "^1.0.1",
@@ -74,5 +74,5 @@
     "react-native-ios11-devicecheck": "^0.0.3"
   },
   "sideEffects": false,
-  "gitHead": "480639829db6f746159c9fd3fba3e69fcbb0cb29"
+  "gitHead": "78342f53c89c0c28a1559e6f0224249f4713c47b"
 }

package/types/CozyClient.d.ts

@@ -40,6 +40,10 @@ export type CozyClientDocument = {
      * - When true the document should NOT be replicated to the remote database
      */
     cozyLocalOnly?: boolean;
+    /**
+     * - Id of a shared drive, only for shared io.cozy.files
+     */
+    driveId?: string;
 };
 export type ClientOptions = {
     client?: object;
@@ -49,6 +53,9 @@ export type ClientOptions = {
     uri?: string;
     stackClient?: object;
     warningForCustomHandlers?: boolean;
+    /**
+     * - If set to true, all documents will be hydrated w.r.t. the provided schema's relationships, even if the relationship does not exist on the doc.
+     */
     autoHydrate?: boolean;
     /**
      * - If set to true, backgroundFetching will be enabled by default on every query. Meaning that, when the fetchStatus has already been loaded, it won't be updated during future fetches. Instead, a `isFetching` attribute will be used to indicate when background fetching is started.
@@ -96,7 +103,7 @@ export type ClientOptions = {
  * @property {string} [uri]
  * @property {object} [stackClient]
  * @property {boolean} [warningForCustomHandlers]
- * @property {boolean} [autoHydrate]
+ * @property {boolean} [autoHydrate] - If set to true, all documents will be hydrated w.r.t. the provided schema's relationships, even if the relationship does not exist on the doc.
  * @property {boolean} [backgroundFetching] - If set to true, backgroundFetching will be enabled by default on every query. Meaning that, when the fetchStatus has already been loaded, it won't be updated during future fetches. Instead, a `isFetching` attribute will be used to indicate when background fetching is started.
  * @property {object} [oauth]
  * @property {Function} [onTokenRefresh]
@@ -108,7 +115,6 @@ export type ClientOptions = {
  * @property  {import("./types").ClientCapabilities} [capabilities] - Capabilities sent by the stack
  * @property  {boolean} [useCustomStore=false] - If set to true, the client will not instantiate a Redux store automatically. Use this if you want to merge cozy-client's store with your own redux store. Note will have to call `setStore` eventually. See [here](https://docs.cozy.io/en/cozy-client/react-integration/#1b-use-your-own-redux-store) for more information.
  * @property  {boolean} [disableStoreForQueries=false] - If set to true, the client will not leverage the redux store to execute queries and store data.
- 
  * @property {import('./performances/types').PerformanceAPI} [performanceApi] - The performance API that can be used to measure performances
  */
 /**
@@ -210,6 +216,9 @@ declare class CozyClient {
         uri?: string;
         stackClient?: object;
         warningForCustomHandlers?: boolean;
+        /**
+         * - If set to true, all documents will be hydrated w.r.t. the provided schema's relationships, even if the relationship does not exist on the doc.
+         */
         autoHydrate?: boolean;
         /**
          * - If set to true, backgroundFetching will be enabled by default on every query. Meaning that, when the fetchStatus has already been loaded, it won't be updated during future fetches. Instead, a `isFetching` attribute will be used to indicate when background fetching is started.
@@ -255,6 +264,7 @@ declare class CozyClient {
      */
     storeAccesors: object;
     useCustomStore: boolean;
+    autoHydrate: boolean;
     disableStoreForQueries: boolean;
     /**
      * Gets overrided by MicroEE.mixin
@@ -355,9 +365,10 @@ declare class CozyClient {
      * a [DocumentCollection]{@link https://docs.cozy.io/en/cozy-client/api/cozy-stack-client/#DocumentCollection} instance.
      *
      * @param  {string} doctype The collection doctype.
+     * @param  {object} options Options to pass to the collection
      * @returns {import("./types").DocumentCollection} Collection corresponding to the doctype
      */
-    collection(doctype: string): import("./types").DocumentCollection;
+    collection(doctype: string, options?: object): import("./types").DocumentCollection;
     fetch(method: any, path: any, body: any, options?: {}): any;
     all(doctype: any): QueryDefinition;
     find(doctype: any, selector?: any): QueryDefinition;
@@ -553,23 +564,6 @@ declare class CozyClient {
      * @returns {Promise<import("./types").ClientResponse>}
      */
     private requestQuery;
-    /**
-     * Save the document or array of documents into the persisted storage (if any)
-     *
-     * @private
-     * @param {CozyClientDocument | Array<CozyClientDocument>} data - Document or array of documents to be saved
-     * @returns {Promise<void>}
-     */
-    private persistVirtualDocuments;
-    /**
-     * Save the document or array of documents into the persisted storage (if any)
-     *
-     * @private
-     * @param {CozyClientDocument} document - Document to be saved
-     * @param {boolean} enforce - When true, save the document even if `meta.rev` or `_rev` exist
-     * @returns {Promise<void>}
-     */
-    private persistVirtualDocument;
     /**
      * Fetch relationships for a response (can be several docs).
      * Fills the `relationships` attribute of each documents.
@@ -607,12 +601,6 @@ declare class CozyClient {
     hydrateRelationships(document: any, schemaRelationships: any): {
         [x: string]: any;
     };
-    /**
-     * Creates (locally) a new document for the given doctype.
-     * This document is hydrated : its relationships are there
-     * and working.
-     */
-    makeNewDocument(doctype: any): any;
     generateRandomId(): string;
     /**
      * Creates an association that is linked to the store.
@@ -662,7 +650,7 @@ declare class CozyClient {
      *
      * @param {string} id - Id of the query (set via Query.props.as)
      * @param {object} options - Options
-     * @param {boolean} [options.hydrated] - Whether documents should be returned already hydrated (default: false)
+     * @param {boolean} [options.hydrated] - Whether documents should be returned already hydrated
      * @param  {object} [options.singleDocData] - If true, the "data" returned will be
      * a single doc instead of an array for single doc queries. Defaults to false for backward
      * compatibility but will be set to true in the future.

package/types/__tests__/fixtures.d.ts

@@ -94,7 +94,7 @@ export namespace TODO_WITH_AUTHOR {
     }
     export { relationships_1 as relationships };
 }
-export namespace FILE_1 {
+export namespace TODO_WITH_NONEXISTING_RELATIONSHIP {
     const _id_6: number;
     export { _id_6 as _id };
     const _rev_6: string;
@@ -103,9 +103,20 @@ export namespace FILE_1 {
     export { _type_6 as _type };
     const label_6: string;
     export { label_6 as label };
-    export const name: string;
+    export namespace relationships_2 {
+        namespace broken {
+            const doctype_2: string;
+            export { doctype_2 as doctype };
+            const data_1: {
+                _type: string;
+                _id: number;
+            }[];
+            export { data_1 as data };
+        }
+    }
+    export { relationships_2 as relationships };
 }
-export namespace FILE_2 {
+export namespace FILE_1 {
     const _id_7: number;
     export { _id_7 as _id };
     const _rev_7: string;
@@ -114,6 +125,17 @@ export namespace FILE_2 {
     export { _type_7 as _type };
     const label_7: string;
     export { label_7 as label };
+    export const name: string;
+}
+export namespace FILE_2 {
+    const _id_8: number;
+    export { _id_8 as _id };
+    const _rev_8: string;
+    export { _rev_8 as _rev };
+    const _type_8: string;
+    export { _type_8 as _type };
+    const label_8: string;
+    export { label_8 as label };
 }
 export const APP_NAME: "cozy-client-test";
 export const APP_VERSION: 2;
@@ -122,38 +144,38 @@ export const SOURCE_ACCOUNT_ID: "123-456-abc";
 export const SOURCE_ACCOUNT_IDENTIFIER: "testSourceAccountIdentifier";
 export namespace SCHEMA {
     export namespace todos {
-        const doctype_2: string;
-        export { doctype_2 as doctype };
+        const doctype_3: string;
+        export { doctype_3 as doctype };
         export { DOCTYPE_VERSION as doctypeVersion };
-        export namespace relationships_2 {
+        export namespace relationships_3 {
             export namespace attachments_1 {
                 export const type: string;
-                const doctype_3: string;
-                export { doctype_3 as doctype };
+                const doctype_4: string;
+                export { doctype_4 as doctype };
             }
             export { attachments_1 as attachments };
             export namespace authors_1 {
                 const type_1: string;
                 export { type_1 as type };
-                const doctype_4: string;
-                export { doctype_4 as doctype };
+                const doctype_5: string;
+                export { doctype_5 as doctype };
             }
             export { authors_1 as authors };
         }
-        export { relationships_2 as relationships };
+        export { relationships_3 as relationships };
     }
     export namespace files_1 {
-        const doctype_5: string;
-        export { doctype_5 as doctype };
-        export namespace relationships_3 {
+        const doctype_6: string;
+        export { doctype_6 as doctype };
+        export namespace relationships_4 {
             namespace icons {
                 const type_2: string;
                 export { type_2 as type };
-                const doctype_6: string;
-                export { doctype_6 as doctype };
+                const doctype_7: string;
+                export { doctype_7 as doctype };
             }
         }
-        export { relationships_3 as relationships };
+        export { relationships_4 as relationships };
     }
     export { files_1 as files };
 }

package/types/queries/dsl.d.ts

@@ -125,6 +125,7 @@ export class QueryDefinition {
      * @param {number|null} [options.skip] - The number of docs to skip.
      * @param {import('../types').CouchDBViewCursor} [options.cursor] - The cursor to paginate views.
      * @param {string} [options.bookmark] - The bookmark to paginate mango queries.
+     * @param {string} [options.sharingId] - The id of the sharing
      */
     constructor(options?: {
         doctype: import('../types').Doctype;
@@ -141,6 +142,7 @@ export class QueryDefinition {
         skip: number | null;
         cursor: import('../types').CouchDBViewCursor;
         bookmark: string;
+        sharingId: string;
     });
     doctype: string;
     id: string;
@@ -156,6 +158,7 @@ export class QueryDefinition {
     skip: number;
     cursor: import("../types").CouchDBViewCursor;
     bookmark: string;
+    sharingId: string;
     /**
      * Checks if the sort order matches the index' fields order.
      *
@@ -291,6 +294,13 @@ export class QueryDefinition {
      * @returns {QueryDefinition}  The QueryDefinition object.
      */
     referencedBy(document: object): QueryDefinition;
+    /**
+     * Use a sharingId to query documents coming from a sharing
+     *
+     * @param {string} id - The sharing doc id
+     * @returns {QueryDefinition}  The QueryDefinition object.
+     */
+    sharingById(id: string): QueryDefinition;
     toDefinition(): {
         doctype: string;
         id: string;
@@ -306,6 +316,7 @@ export class QueryDefinition {
         skip: number;
         cursor: import("../types").CouchDBViewCursor;
         bookmark: string;
+        sharingId: string;
     };
 }
 declare const CREATE_DOCUMENT: "CREATE_DOCUMENT";

package/types/storage.d.ts

@@ -43,6 +43,10 @@ export type CozyClientDocument = {
      * - When true the document should NOT be replicated to the remote database
      */
     cozyLocalOnly?: boolean;
+    /**
+     * - Id of a shared drive, only for shared io.cozy.files
+     */
+    driveId?: string;
 };
 import CozyClient from "./CozyClient";
 import { QueryDefinition } from "./queries/dsl";

package/types/store/selector.d.ts

@@ -0,0 +1 @@
+export function equalityCheckForQuery(queryResA: import("../types").QueryState, queryResB: import("../types").QueryState): boolean;

package/types/types.d.ts

@@ -503,12 +503,25 @@ export type QueryStateWithoutData = {
     fetchedPagesCount: number;
     bookmark: string;
     execution_stats?: object;
+    /**
+     * - The relationships names, used to check hydrated documents
+     */
+    relationshipNames: Array<string>;
     options?: QueryOptions;
 };
 export type QueryStateData = {
+    /**
+     * - Collection of hydrated documents
+     */
     data: object | any[];
 };
-export type QueryState = QueryStateWithoutData & QueryStateData;
+export type QueryStateStoreData = {
+    /**
+     * - Collection of store's documents
+     */
+    storeData: object | any[];
+};
+export type QueryState = QueryStateWithoutData & QueryStateData & QueryStateStoreData;
 export type AutoUpdateOptions = any;
 export type QueryOptions = {
     /**
@@ -568,7 +581,7 @@ export type FetchMoreAble = {
 export type FetchAble = {
     fetch: Function;
 };
-export type UseQueryReturnValue = QueryStateWithoutData & QueryStateData & FetchMoreAble & FetchAble;
+export type UseQueryReturnValue = QueryStateWithoutData & QueryStateData & QueryStateStoreData & FetchMoreAble & FetchAble;
 export type UseMutationWithoutMutate = {
     /**
      * - Status of the current mutation
@@ -802,6 +815,10 @@ export type CozyClientDocument = {
      * - When true the document should NOT be replicated to the remote database
      */
     cozyLocalOnly?: boolean;
+    /**
+     * - Id of a shared drive, only for shared io.cozy.files
+     */
+    driveId?: string;
 };
 /**
  * - A io.cozy.files document's metadata