cozy-client 29.2.0 → 30.0.0

package/dist/CozyClient.js

@@ -2550,7 +2550,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 = "29.2.0";
+CozyClient.version = "30.0.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/queries/dsl.js

@@ -29,6 +29,8 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
  * @property {Array} [indexedFields]
  * @property {Array} [sort]
  * @property {object} [selector]
+ * @property {object} [partialFilter]
+ * @property {Array} [fields]
  */
 
 /**
@@ -155,6 +157,42 @@ var QueryDefinition = /*#__PURE__*/function () {
         console.info("The use of the $ne operator is more efficient with a partial index.\n\n        Selector: ".concat(selector));
       }
     }
+    /**
+     * Check if the selected fields are all included in the selectors
+     *
+     * @param {PartialQueryDefinition} obj - A partial QueryDefinition to check
+     */
+
+  }, {
+    key: "checkSelectFields",
+    value: function checkSelectFields(_ref2) {
+      var fields = _ref2.fields,
+          selector = _ref2.selector,
+          partialFilter = _ref2.partialFilter;
+
+      var _fields = this.fields || fields;
+
+      var _selector = this.selector || selector;
+
+      var _partialFilter = this.partialFilter || partialFilter;
+
+      if (!_fields || !_selector && !_partialFilter) {
+        return;
+      }
+
+      var mergedSelector = _objectSpread(_objectSpread({}, _selector), _partialFilter);
+
+      var selectorAttributes = Object.keys(mergedSelector);
+      var hasEveryFieldsInSelector = selectorAttributes.every(function (attribute) {
+        return _fields.includes(attribute);
+      });
+
+      if (!hasEveryFieldsInSelector) {
+        throw new Error("The .select should includes all the fields used in where or partialIndex.\n        Please fix this query: fields: ".concat(JSON.stringify(this.toDefinition())));
+      }
+
+      return;
+    }
     /**
      * Query a single document on its id.
      *
@@ -202,6 +240,9 @@ var QueryDefinition = /*#__PURE__*/function () {
         selector: selector
       });
       this.checkSelector(selector);
+      this.checkSelectFields({
+        selector: selector
+      });
       return new QueryDefinition(_objectSpread(_objectSpread({}, this.toDefinition()), {}, {
         selector: selector
       }));
@@ -216,6 +257,9 @@ var QueryDefinition = /*#__PURE__*/function () {
   }, {
     key: "select",
     value: function select(fields) {
+      this.checkSelectFields({
+        fields: fields
+      });
       return new QueryDefinition(_objectSpread(_objectSpread({}, this.toDefinition()), {}, {
         fields: fields
       }));
@@ -250,6 +294,9 @@ var QueryDefinition = /*#__PURE__*/function () {
   }, {
     key: "partialIndex",
     value: function partialIndex(partialFilter) {
+      this.checkSelectFields({
+        partialFilter: partialFilter
+      });
       return new QueryDefinition(_objectSpread(_objectSpread({}, this.toDefinition()), {}, {
         partialFilter: partialFilter
       }));

package/dist/queries/dsl.spec.js

@@ -107,4 +107,43 @@ describe('QueryDefinition', () => {
     Q('io.cozy.files').where({ _id: { $ne: 'io.cozy.root-id' } })
     expect(console.info).toHaveBeenCalledTimes(1)
   })
+
+  it('should throw an error when there is a select without all the fields in selector', () => {
+    const query = () =>
+      Q('io.cozy.files')
+        .where({ name: 'saymyname' })
+        .select(['size'])
+    expect(() => query()).toThrow()
+  })
+  it('should throw an error when there is a select without all the fields in partial index', () => {
+    const query = () =>
+      Q('io.cozy.files')
+        .where({ size: 42 })
+        .partialIndex({ name: { $exists: true } })
+        .select(['size'])
+    expect(() => query()).toThrow()
+  })
+  it('should throw an error when there is a select without all the fields in nor selector nor partial index', () => {
+    const query = () =>
+      Q('io.cozy.files')
+        .where({ size: 42 })
+        .partialIndex({ name: { $exists: true } })
+        .select(['date'])
+    expect(() => query()).toThrow()
+  })
+  it('should not throw when there is a select with all the fields in selector and partial index', () => {
+    const query = () =>
+      Q('io.cozy.files')
+        .where(
+          {
+            size: 42
+          },
+          {
+            date: '2021-01-01'
+          }
+        )
+        .partialIndex({ name: { $exists: true } })
+        .select(['date', 'size', 'name', 'trashed'])
+    expect(() => query()).not.toThrow()
+  })
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "29.2.0",
+  "version": "30.0.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -18,7 +18,7 @@
     "@types/jest": "^26.0.20",
     "@types/lodash": "^4.14.170",
     "btoa": "^1.2.1",
-    "cozy-stack-client": "^29.2.0",
+    "cozy-stack-client": "^30.0.0",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.13",
     "microee": "^0.0.6",
@@ -73,5 +73,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "50cc3d6b5b6bdcbc231fe2a584fc17415d177bd6"
+  "gitHead": "eb60edf72cb815882e8adb04e52a70c31f090e67"
 }

package/types/queries/dsl.d.ts

@@ -68,6 +68,8 @@ export type PartialQueryDefinition = {
     indexedFields?: any[];
     sort?: any[];
     selector?: object;
+    partialFilter?: object;
+    fields?: any[];
 };
 export type MangoSelector = any;
 export type MangoPartialFilter = any;
@@ -78,6 +80,8 @@ import { Doctype } from "../types";
  * @property {Array} [indexedFields]
  * @property {Array} [sort]
  * @property {object} [selector]
+ * @property {object} [partialFilter]
+ * @property {Array} [fields]
  */
 /**
  * @typedef {object} MangoSelector
@@ -162,6 +166,12 @@ export class QueryDefinition {
      * @returns {void}
      */
     checkSelector(selector: MangoSelector): void;
+    /**
+     * Check if the selected fields are all included in the selectors
+     *
+     * @param {PartialQueryDefinition} obj - A partial QueryDefinition to check
+     */
+    checkSelectFields({ fields, selector, partialFilter }: PartialQueryDefinition): void;
     /**
      * Query a single document on its id.
      *