cozy-client 27.14.3 → 27.14.4

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [27.14.4](https://github.com/cozy/cozy-client/compare/v27.14.3...v27.14.4) (2022-01-31)
+
+**Note:** Version bump only for package cozy-client
+
+
+
+
+
 ## [27.14.3](https://github.com/cozy/cozy-client/compare/v27.14.2...v27.14.3) (2022-01-28)
 
 

package/dist/CozyClient.js

@@ -2464,7 +2464,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 = "27.14.3";
+CozyClient.version = "27.14.4";
 
 _microee.default.mixin(CozyClient);
 

package/dist/RealTimeQueries.js

@@ -48,6 +48,7 @@ var normalizeDoc = function normalizeDoc(couchDBDoc, doctype) {
  * DispatchChange
  *
  * @param {CozyClient} client CozyClient instane
+ * @param {Doctype} doctype Doctype of the document to update
  * @param {CouchDBDocument} couchDBDoc Document to update
  * @param {Mutation} mutationDefinitionCreator Mutation to apply
  */

package/dist/associations/HasManyFiles.js

@@ -27,6 +27,8 @@ var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime
 
 var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
 
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+
 var _get4 = _interopRequireDefault(require("lodash/get"));
 
 var _omit = _interopRequireDefault(require("lodash/omit"));
@@ -53,11 +55,30 @@ function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflec
 
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
 
+/**
+ * newCursor - Returns a CouchDB view Cursor for cursor-based pagination
+ *
+ * @param {ViewKey} key - The CouchDB key of the view which will be requested
+ * @param {DocId} startDocId - The first doc _id to return from the view
+ *
+ * @returns {CouchDBViewCursor}
+ */
+var newCursor = function newCursor(_ref, startDocId) {
+  var _ref2 = (0, _slicedToArray2.default)(_ref, 3),
+      doctype = _ref2[0],
+      id = _ref2[1],
+      lastDatetime = _ref2[2];
+
+  var cursorKey = lastDatetime ? [doctype, id, lastDatetime] : [doctype, id];
+  return [cursorKey, startDocId];
+};
 /**
  *  This class is only used for photos albums relationships.
  *  Behind the hood, the queries uses a view returning the files sorted
  *  by datetime, with a cursor-based pagination.
  */
+
+
 var HasManyFiles = /*#__PURE__*/function (_HasMany) {
   (0, _inherits2.default)(HasManyFiles, _HasMany);
 
@@ -87,8 +108,8 @@ var HasManyFiles = /*#__PURE__*/function (_HasMany) {
                 lastRelationship = relationships[relationships.length - 1];
                 _context2.next = 5;
                 return this.dispatch( /*#__PURE__*/function () {
-                  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(dispatch, getState) {
-                    var lastRelDoc, lastDatetime, cursorKey, startDocId, cursorView, response;
+                  var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(dispatch, getState) {
+                    var lastRelDoc, lastDatetime, cursor, response;
                     return _regenerator.default.wrap(function _callee$(_context) {
                       while (1) {
                         switch (_context.prev = _context.next) {
@@ -97,17 +118,15 @@ var HasManyFiles = /*#__PURE__*/function (_HasMany) {
 
                             lastDatetime = lastRelDoc.attributes.metadata.datetime; // cursor-based pagination
 
-                            cursorKey = [_this.target._type, _this.target._id, lastDatetime];
-                            startDocId = relationships[relationships.length - 1]._id;
-                            cursorView = [cursorKey, startDocId];
-                            _context.next = 7;
-                            return _this.query(queryDef.referencedBy(_this.target).offsetCursor(cursorView));
+                            cursor = newCursor([_this.target._type, _this.target._id, lastDatetime], relationships[relationships.length - 1]._id);
+                            _context.next = 5;
+                            return _this.query(queryDef.referencedBy(_this.target).offsetCursor(cursor));
 
-                          case 7:
+                          case 5:
                             response = _context.sent;
                             // Remove first returned element, used as starting point for the query
                             response.data.shift();
-                            _context.next = 11;
+                            _context.next = 9;
                             return _this.dispatch(_this.updateRelationshipData(function (previousRelationshipData) {
                               return _objectSpread(_objectSpread({}, previousRelationshipData), {}, {
                                 data: [].concat((0, _toConsumableArray2.default)(previousRelationshipData.data), (0, _toConsumableArray2.default)(response.data)),
@@ -115,7 +134,7 @@ var HasManyFiles = /*#__PURE__*/function (_HasMany) {
                               });
                             }));
 
-                          case 11:
+                          case 9:
                           case "end":
                             return _context.stop();
                         }
@@ -124,7 +143,7 @@ var HasManyFiles = /*#__PURE__*/function (_HasMany) {
                   }));
 
                   return function (_x, _x2) {
-                    return _ref.apply(this, arguments);
+                    return _ref3.apply(this, arguments);
                   };
                 }());
 
@@ -261,9 +280,9 @@ var HasManyFiles = /*#__PURE__*/function (_HasMany) {
 
       if (this.target._type === _const.DOCTYPE_FILES) {
         var refs = (0, _get4.default)(this.target, 'referenced_by', []);
-        return refs.map(function (_ref2) {
-          var id = _ref2.id,
-              type = _ref2.type;
+        return refs.map(function (_ref4) {
+          var id = _ref4.id,
+              type = _ref4.type;
           return _this4.get(type, id);
         }).filter(Boolean);
       } else {
@@ -282,8 +301,7 @@ var HasManyFiles = /*#__PURE__*/function (_HasMany) {
         }));
         return ids.length > 0 ? (0, _dsl.Q)(assoc.doctype).getByIds(ids) : null;
       } else {
-        var key = [document._type, document._id];
-        var cursor = [key, ''];
+        var cursor = newCursor([document._type, document._id], '');
         return (0, _dsl.Q)(assoc.doctype).referencedBy(document).offsetCursor(cursor);
       }
     }

package/dist/flagship-certification/typedefs.js

@@ -1,24 +1,20 @@
 /**
- * A JSON Web Signature
- * @typedef {string} jws
+ * @typedef {string} jws - A JSON Web Signature
  */
 
 /**
- * A JSON Web Signature
- * @typedef {string} base64string
+ * @typedef {string} base64string - A JSON Web Signature
  */
 
 /**
- * An app attestation from the app store
- * @typedef {object} AttestationResult
+ * @typedef {object} AttestationResult - An app attestation from the app store
  * @property {string} platform
  * @property {jws|base64string} attestation
  * @property {string} [keyId]
  */
 
 /**
- * Configuration to access the stores certification API
- * @typedef {object} CertificationConfig
+ * @typedef {object} CertificationConfig - Configuration to access the stores certification API
  * @property {string} androidSafetyNetApiKey
  */
 "use strict";

package/dist/queries/dsl.js

@@ -36,7 +36,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
  */
 
 /**
- * @typedef {Array} Cursor
+ * @typedef {object} MangoPartialFilter
  */
 
 /**
@@ -50,19 +50,19 @@ var QueryDefinition = /*#__PURE__*/function () {
    * @class
    *
    * @param {object} options Initial options for the query definition
-   * @param {string} [options.doctype] - The doctype of the doc.
-   * @param {string} [options.id] - The id of the doc.
-   * @param {Array} [options.ids] - The ids of the docs.
-   * @param {object} [options.selector] - The selector to query the docs.
-   * @param {Array} [options.fields] - The fields to return.
-   * @param {Array} [options.indexedFields] - The fields to index.
-   * @param {object} [options.partialFilter] - The partial index definition to filter docs.
-   * @param {Array} [options.sort] - The sorting params.
+   * @param {Doctype} [options.doctype] - The doctype of the doc.
+   * @param {DocId|null} [options.id] - The id of the doc.
+   * @param {Array<DocId>} [options.ids] - The ids of the docs.
+   * @param {MangoSelector} [options.selector] - The selector to query the docs.
+   * @param {Array<string>} [options.fields] - The fields to return.
+   * @param {Array<string>} [options.indexedFields] - The fields to index.
+   * @param {MangoPartialFilter} [options.partialFilter] - The partial index definition to filter docs.
+   * @param {Array<object>} [options.sort] - The sorting params.
    * @param {Array<string>} [options.includes] - The docs to include.
-   * @param {string} [options.referenced] - The referenced document.
+   * @param {string|null} [options.referenced] - The referenced document.
    * @param {number|null} [options.limit] - The document's limit to return.
-   * @param {number} [options.skip] - The number of docs to skip.
-   * @param {Cursor} [options.cursor] - The cursor to paginate views.
+   * @param {number|null} [options.skip] - The number of docs to skip.
+   * @param {CouchDBViewCursor} [options.cursor] - The cursor to paginate views.
    * @param {string} [options.bookmark] - The bookmark to paginate mango queries.
    */
   function QueryDefinition() {
@@ -342,7 +342,7 @@ var QueryDefinition = /*#__PURE__*/function () {
      * the starting document of the query, e.g. "file-id".
      * Use the last docid of each query as startkey_docid to paginate or leave blank for the first query.
      *
-     * @param {Cursor} cursor The cursor for pagination.
+     * @param {CouchDBViewCursor} cursor The cursor for pagination.
      * @returns {QueryDefinition}  The QueryDefinition object.
      */
 

package/dist/queries/dsl.spec.js

@@ -50,8 +50,9 @@ describe('QueryDefinition', () => {
     expect(withSkip.bookmark).toBeUndefined()
     expect(withSkip.cursor).toBeUndefined()
 
-    const withCursor = withSkip.offsetCursor('cursor-id')
-    expect(withCursor.cursor).toEqual('cursor-id')
+    const cursor = [['io.cozy.files', '1234'], 'xyz']
+    const withCursor = withSkip.offsetCursor(cursor)
+    expect(withCursor.cursor).toEqual(cursor)
     expect(withCursor.bookmark).toBeUndefined()
     expect(withCursor.skip).toBeUndefined()
 

package/dist/types.js

@@ -167,7 +167,7 @@ var _dsl = require("./queries/dsl");
  * @property {string} name - Name of the folder
  * @property {object} metadata - Metadata of the folder
  * @property {object} type - Type of the folder
- * @typedef {CozyClientDocument & FileDocument} IOCozyFolder - An io.cozy.files document
+ * @typedef {CozyClientDocument & FolderDocument} IOCozyFolder - An io.cozy.files document
  */
 
 /**
@@ -253,6 +253,12 @@ var _dsl = require("./queries/dsl");
  * @property {string?} reason?
  */
 
+/**
+ * @typedef {Array<string>|string} ViewKey
+ * @typedef {string} DocId
+ * @typedef {[ViewKey, DocId]} CouchDBViewCursor
+ */
+
 /**
  * @typedef {object} Theme
  * @property {string} id

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "27.14.3",
+  "version": "27.14.4",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -21,7 +21,7 @@
     "cozy-device-helper": "^1.12.0",
     "cozy-flags": "2.7.1",
     "cozy-logger": "^1.6.0",
-    "cozy-stack-client": "^27.14.1",
+    "cozy-stack-client": "^27.14.4",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.13",
     "microee": "^0.0.6",
@@ -71,5 +71,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "786f6d73d3d1cc0f423776e2af642f8bdd3fba2c"
+  "gitHead": "df8a41fff60d8b4492e240932dd6858641c861d3"
 }

package/types/flagship-certification/typedefs.d.ts

@@ -1,13 +1,13 @@
 /**
- * A JSON Web Signature
+ * - A JSON Web Signature
  */
 type jws = string;
 /**
- * A JSON Web Signature
+ * - A JSON Web Signature
  */
 type base64string = string;
 /**
- * An app attestation from the app store
+ * - An app attestation from the app store
  */
 type AttestationResult = {
     platform: string;
@@ -15,7 +15,7 @@ type AttestationResult = {
     keyId?: string;
 };
 /**
- * Configuration to access the stores certification API
+ * - Configuration to access the stores certification API
  */
 type CertificationConfig = {
     androidSafetyNetApiKey: string;

package/types/queries/dsl.d.ts

@@ -70,7 +70,7 @@ export type PartialQueryDefinition = {
     selector?: object;
 };
 export type MangoSelector = any;
-export type Cursor = any[];
+export type MangoPartialFilter = any;
 import { Doctype } from "../types";
 /**
  * @typedef PartialQueryDefinition
@@ -83,7 +83,7 @@ import { Doctype } from "../types";
  * @typedef {object} MangoSelector
  */
 /**
- * @typedef {Array} Cursor
+ * @typedef {object} MangoPartialFilter
  */
 /**
  * Chainable API to create query definitions to retrieve documents
@@ -96,50 +96,50 @@ export class QueryDefinition {
      * @class
      *
      * @param {object} options Initial options for the query definition
-     * @param {string} [options.doctype] - The doctype of the doc.
-     * @param {string} [options.id] - The id of the doc.
-     * @param {Array} [options.ids] - The ids of the docs.
-     * @param {object} [options.selector] - The selector to query the docs.
-     * @param {Array} [options.fields] - The fields to return.
-     * @param {Array} [options.indexedFields] - The fields to index.
-     * @param {object} [options.partialFilter] - The partial index definition to filter docs.
-     * @param {Array} [options.sort] - The sorting params.
+     * @param {Doctype} [options.doctype] - The doctype of the doc.
+     * @param {DocId|null} [options.id] - The id of the doc.
+     * @param {Array<DocId>} [options.ids] - The ids of the docs.
+     * @param {MangoSelector} [options.selector] - The selector to query the docs.
+     * @param {Array<string>} [options.fields] - The fields to return.
+     * @param {Array<string>} [options.indexedFields] - The fields to index.
+     * @param {MangoPartialFilter} [options.partialFilter] - The partial index definition to filter docs.
+     * @param {Array<object>} [options.sort] - The sorting params.
      * @param {Array<string>} [options.includes] - The docs to include.
-     * @param {string} [options.referenced] - The referenced document.
+     * @param {string|null} [options.referenced] - The referenced document.
      * @param {number|null} [options.limit] - The document's limit to return.
-     * @param {number} [options.skip] - The number of docs to skip.
-     * @param {Cursor} [options.cursor] - The cursor to paginate views.
+     * @param {number|null} [options.skip] - The number of docs to skip.
+     * @param {CouchDBViewCursor} [options.cursor] - The cursor to paginate views.
      * @param {string} [options.bookmark] - The bookmark to paginate mango queries.
      */
     constructor(options?: {
-        doctype: string;
-        id: string;
-        ids: any[];
-        selector: object;
-        fields: any[];
-        indexedFields: any[];
-        partialFilter: object;
-        sort: any[];
+        doctype: Doctype;
+        id: DocId | null;
+        ids: Array<DocId>;
+        selector: MangoSelector;
+        fields: Array<string>;
+        indexedFields: Array<string>;
+        partialFilter: MangoPartialFilter;
+        sort: Array<object>;
         includes: Array<string>;
-        referenced: string;
+        referenced: string | null;
         limit: number | null;
-        skip: number;
-        cursor: Cursor;
+        skip: number | null;
+        cursor: CouchDBViewCursor;
         bookmark: string;
     });
     doctype: string;
     id: string;
-    ids: any[];
+    ids: string[];
     selector: any;
-    fields: any[];
-    indexedFields: any[];
+    fields: string[];
+    indexedFields: string[];
     partialFilter: any;
     sort: any[];
     includes: string[];
     referenced: string;
     limit: number;
     skip: number;
-    cursor: Cursor;
+    cursor: CouchDBViewCursor;
     bookmark: string;
     /**
      * Checks if the sort order matches the index' fields order.
@@ -249,10 +249,10 @@ export class QueryDefinition {
      * the starting document of the query, e.g. "file-id".
      * Use the last docid of each query as startkey_docid to paginate or leave blank for the first query.
      *
-     * @param {Cursor} cursor The cursor for pagination.
+     * @param {CouchDBViewCursor} cursor The cursor for pagination.
      * @returns {QueryDefinition}  The QueryDefinition object.
      */
-    offsetCursor(cursor: Cursor): QueryDefinition;
+    offsetCursor(cursor: CouchDBViewCursor): QueryDefinition;
     /**
      * Use [bookmark](https://docs.couchdb.org/en/2.2.0/api/database/find.html#pagination) pagination.
      * Note this only applies for mango-queries (not views) and is way more efficient than skip pagination.
@@ -273,17 +273,17 @@ export class QueryDefinition {
     toDefinition(): {
         doctype: string;
         id: string;
-        ids: any[];
+        ids: string[];
         selector: any;
-        fields: any[];
-        indexedFields: any[];
+        fields: string[];
+        indexedFields: string[];
         partialFilter: any;
         sort: any[];
         includes: string[];
         referenced: string;
         limit: number;
         skip: number;
-        cursor: Cursor;
+        cursor: CouchDBViewCursor;
         bookmark: string;
     };
 }
@@ -296,4 +296,6 @@ declare const REMOVE_REFERENCES_TO: "REMOVE_REFERENCES_TO";
 declare const ADD_REFERENCED_BY: "ADD_REFERENCED_BY";
 declare const REMOVE_REFERENCED_BY: "REMOVE_REFERENCED_BY";
 declare const UPLOAD_FILE: "UPLOAD_FILE";
+import { CouchDBViewCursor } from "../types";
+import { DocId } from "../types";
 export {};

package/types/types.d.ts

@@ -208,7 +208,7 @@ export type FolderDocument = {
 /**
  * - An io.cozy.files document
  */
-export type IOCozyFolder = CozyClientDocument & FileDocument;
+export type IOCozyFolder = CozyClientDocument & FolderDocument;
 /**
  * - An io.cozy.oauth.clients document
  */
@@ -299,6 +299,9 @@ export type CouchDBBulkResult = {
      */
     reason: string | null;
 };
+export type ViewKey = string | string[];
+export type DocId = string;
+export type CouchDBViewCursor = [string | string[], string];
 export type Theme = {
     id: string;
     label: string;