cozy-client 60.0.0 → 60.1.1

package/dist/links/StackLink.js

@@ -288,7 +288,12 @@ var StackLink = /*#__PURE__*/function (_CozyLink) {
           id = query.id,
           ids = query.ids,
           referenced = query.referenced,
-          options = (0, _objectWithoutProperties2.default)(query, ["doctype", "selector", "id", "ids", "referenced"]);
+          sharingId = query.sharingId,
+          rawOptions = (0, _objectWithoutProperties2.default)(query, ["doctype", "selector", "id", "ids", "referenced", "sharingId"]);
+
+      var options = _objectSpread(_objectSpread({}, rawOptions), {}, {
+        driveId: undefined
+      });
 
       if (!doctype) {
         _logger.default.warn('Bad query', query);
@@ -296,7 +301,13 @@ var StackLink = /*#__PURE__*/function (_CozyLink) {
         throw new Error('No doctype found in a query definition');
       }
 
-      var collection = this.stackClient.collection(doctype);
+      if (doctype === _const.DOCTYPE_FILES && sharingId) {
+        options = _objectSpread(_objectSpread({}, options), {}, {
+          driveId: sharingId
+        });
+      }
+
+      var collection = this.stackClient.collection(doctype, options);
 
       if (id) {
         return collection.get(id, query);

package/dist/links/StackLink.spec.js

@@ -18,7 +18,10 @@ describe('StackLink', () => {
       stackClient.collection().all.mockReset()
       await link.request(query)
       expect(stackClient.collection().all).toHaveBeenCalled()
-      expect(stackClient.collection).toHaveBeenCalledWith('io.cozy.todos')
+      expect(stackClient.collection).toHaveBeenCalledWith(
+        'io.cozy.todos',
+        expect.anything()
+      )
     })
 
     it('should execute queries with a selector', async () => {
@@ -36,7 +39,10 @@ describe('StackLink', () => {
       stackClient.collection().find.mockReset()
       await link.request(query)
       expect(stackClient.collection().find).toHaveBeenCalled()
-      expect(stackClient.collection).toHaveBeenCalledWith('io.cozy.todos')
+      expect(stackClient.collection).toHaveBeenCalledWith(
+        'io.cozy.todos',
+        expect.anything()
+      )
     })
 
     it('should use all if a no sort option is given', async () => {
@@ -44,7 +50,10 @@ describe('StackLink', () => {
       stackClient.collection().all.mockReset()
       await link.request(query)
       expect(stackClient.collection().all).toHaveBeenCalled()
-      expect(stackClient.collection).toHaveBeenCalledWith('io.cozy.todos')
+      expect(stackClient.collection).toHaveBeenCalledWith(
+        'io.cozy.todos',
+        expect.anything()
+      )
     })
 
     it('should use find if a partialFilter is given', async () => {
@@ -52,7 +61,10 @@ describe('StackLink', () => {
       stackClient.collection().find.mockReset()
       await link.request(query)
       expect(stackClient.collection().find).toHaveBeenCalled()
-      expect(stackClient.collection).toHaveBeenCalledWith('io.cozy.todos')
+      expect(stackClient.collection).toHaveBeenCalledWith(
+        'io.cozy.todos',
+        expect.anything()
+      )
     })
 
     it('should use find if fields are given', async () => {
@@ -60,7 +72,10 @@ describe('StackLink', () => {
       stackClient.collection().find.mockReset()
       await link.request(query)
       expect(stackClient.collection().find).toHaveBeenCalled()
-      expect(stackClient.collection).toHaveBeenCalledWith('io.cozy.todos')
+      expect(stackClient.collection).toHaveBeenCalledWith(
+        'io.cozy.todos',
+        expect.anything()
+      )
     })
   })
 

package/dist/models/file.spec.js

@@ -430,7 +430,8 @@ describe('File Model', () => {
         'mydoc.odt'
       )
       expect(cozyClient.stackClient.collection).toHaveBeenCalledWith(
-        'io.cozy.files'
+        'io.cozy.files',
+        expect.anything()
       )
       expect(getSpy).toHaveBeenCalledWith(
         'parent',
@@ -447,7 +448,8 @@ describe('File Model', () => {
         'mydoc.odt'
       )
       expect(cozyClient.stackClient.collection).toHaveBeenCalledWith(
-        'io.cozy.files'
+        'io.cozy.files',
+        expect.anything()
       )
       expect(getSpy).toHaveBeenCalledWith(
         'parent',

package/dist/queries/dsl.js

@@ -64,6 +64,7 @@ var QueryDefinition = /*#__PURE__*/function () {
    * @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
    */
   function QueryDefinition() {
     var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -82,6 +83,7 @@ var QueryDefinition = /*#__PURE__*/function () {
     this.skip = options.skip;
     this.cursor = options.cursor;
     this.bookmark = options.bookmark;
+    this.sharingId = options.sharingId;
   }
   /**
    * Checks if the sort order matches the index' fields order.
@@ -444,6 +446,20 @@ var QueryDefinition = /*#__PURE__*/function () {
         referenced: document
       }));
     }
+    /**
+     * Use a sharingId to query documents coming from a sharing
+     *
+     * @param {string} id - The sharing doc id
+     * @returns {QueryDefinition}  The QueryDefinition object.
+     */
+
+  }, {
+    key: "sharingById",
+    value: function sharingById(id) {
+      return new QueryDefinition(_objectSpread(_objectSpread({}, this.toDefinition()), {}, {
+        sharingId: id
+      }));
+    }
   }, {
     key: "toDefinition",
     value: function toDefinition() {
@@ -461,7 +477,8 @@ var QueryDefinition = /*#__PURE__*/function () {
         limit: this.limit,
         skip: this.skip,
         cursor: this.cursor,
-        bookmark: this.bookmark
+        bookmark: this.bookmark,
+        sharingId: this.sharingId
       };
     }
   }]);

package/dist/storage.js

@@ -54,6 +54,11 @@ var shouldDocumentBePersisted = function shouldDocumentBePersisted(document) {
     return true;
   }
 
+  if (document.driveId && document._type === 'io.cozy.files') {
+    // Special case for files in shared drives, so remote files could be locally persisted
+    return true;
+  }
+
   return false;
 };
 /**

package/dist/store/__snapshots__/queries.spec.js.snap

@@ -19,6 +19,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -60,6 +61,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -100,6 +102,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -140,6 +143,7 @@ Object {
         },
         "done": true,
       },
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -180,6 +184,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -217,6 +222,7 @@ Object {
       "selector": Object {
         "done": true,
       },
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -259,6 +265,7 @@ Object {
       "selector": Object {
         "done": false,
       },
+      "sharingId": undefined,
       "skip": undefined,
       "sort": Array [
         Object {
@@ -298,6 +305,7 @@ Object {
       "selector": Object {
         "done": true,
       },
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -339,6 +347,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -375,6 +384,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -415,6 +425,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -450,6 +461,7 @@ Object {
       "selector": Object {
         "done": true,
       },
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -492,6 +504,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -525,6 +538,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -565,6 +579,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -602,6 +617,7 @@ Object {
       "selector": Object {
         "done": true,
       },
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -646,6 +662,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -681,6 +698,7 @@ Object {
       "selector": Object {
         "done": false,
       },
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -723,6 +741,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -761,6 +780,7 @@ Object {
       },
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },

package/dist/types.js

@@ -464,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": "60.0.0",
+  "version": "60.1.1",
   "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": "^60.0.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": "a89eb840497357fb366bc97d92e4a5880fd55099"
+  "gitHead": "a944c176ad97aa07f7145d97642716a9dc231990"
 }

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;
@@ -361,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;
@@ -559,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.
@@ -596,9 +584,13 @@ declare class CozyClient {
      *
      * @param  {string} doctype - Doctype of the documents being hydrated
      * @param  {Array<import("./types").CozyClientDocument>} documents - Documents to be hydrated
+     * @param  {object} [options] - Options
+     * @param  {boolean} [options.forceHydratation=false] - 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.
      * @returns {Array<import("./types").HydratedDocument>}
      */
-    hydrateDocuments(doctype: string, documents: Array<import("./types").CozyClientDocument>): Array<import("./types").HydratedDocument>;
+    hydrateDocuments(doctype: string, documents: Array<import("./types").CozyClientDocument>, { forceHydratation }?: {
+        forceHydratation?: boolean;
+    }): Array<import("./types").HydratedDocument>;
     /**
      * Resolves relationships on a document.
      *
@@ -606,11 +598,17 @@ declare class CozyClient {
      * the relationship
      *
      * @param  {import("./types").CozyClientDocument} document - for which relationships must be resolved
-     * @param  {Schema} [schemaArg] - Optional
+     * @param  {Schema} [schemaArg] - The schema describing the relationships
+     * @param  {object} [options] - Options
+     * @param  {boolean} [options.forceHydratation=false] - If set to true, the doc will be hydrated w.r.t. the provided schema's relationships, even if the relationship does not exist on the doc.
      * @returns {import("./types").HydratedDocument}
      */
-    hydrateDocument(document: import("./types").CozyClientDocument, schemaArg?: Schema): import("./types").HydratedDocument;
-    hydrateRelationships(document: any, schemaRelationships: any): {
+    hydrateDocument(document: import("./types").CozyClientDocument, schemaArg?: Schema, { forceHydratation }?: {
+        forceHydratation?: boolean;
+    }): import("./types").HydratedDocument;
+    hydrateRelationships(document: any, schemaRelationships: any, { forceHydratation }?: {
+        forceHydratation?: boolean;
+    }): {
         [x: string]: any;
     };
     generateRandomId(): string;

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/types.d.ts

@@ -815,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