cozy-client 27.3.2 → 27.6.0

package/CHANGELOG.md

@@ -3,6 +3,51 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [27.6.0](https://github.com/cozy/cozy-client/compare/v27.5.1...v27.6.0) (2021-12-13)
+
+
+### Features
+
+* Add some helpers for model file ([e074067](https://github.com/cozy/cozy-client/commit/e0740674bb250b979fc3a6bfeace771de3d3c2fd))
+
+
+
+
+
+## [27.5.1](https://github.com/cozy/cozy-client/compare/v27.5.0...v27.5.1) (2021-12-01)
+
+
+### Bug Fixes
+
+* Re-export associations helpers ([9a8d841](https://github.com/cozy/cozy-client/commit/9a8d84135762a1cf0ce29c7da247ca9a4ec617e5)), closes [#1076](https://github.com/cozy/cozy-client/issues/1076)
+
+
+
+
+
+# [27.5.0](https://github.com/cozy/cozy-client/compare/v27.4.0...v27.5.0) (2021-12-01)
+
+
+### Features
+
+* Added referencedBy helpers ([2bd77e4](https://github.com/cozy/cozy-client/commit/2bd77e451eab26b85b21b41db522a7da6378672b))
+* Adding types around references ([6d9c8aa](https://github.com/cozy/cozy-client/commit/6d9c8aade0ece644674b9adfee1b08b8eff7482e))
+
+
+
+
+
+# [27.4.0](https://github.com/cozy/cozy-client/compare/v27.3.2...v27.4.0) (2021-11-25)
+
+
+### Features
+
+* onError Callback ([c5f65d3](https://github.com/cozy/cozy-client/commit/c5f65d33e0ab29a22b409365151173a3b7645b56))
+
+
+
+
+
 ## [27.3.2](https://github.com/cozy/cozy-client/compare/v27.3.1...v27.3.2) (2021-11-17)
 
 

package/dist/CozyClient.js

@@ -128,7 +128,7 @@ var DOC_UPDATE = 'update';
  * @property {boolean} [autoHydrate]
  * @property {object} [oauth]
  * @property {Function} [onTokenRefresh]
- * @property {Function} [onTokenRefresh]
+ * @property {Function} [onError] - Default callback if a query is errored
  * @property  {Link}         [link]   - Backward compatibility
  * @property  {Array<Link>}  [links]  - List of links
  * @property  {object}       [schema] - Schema description for each doctypes
@@ -1276,10 +1276,32 @@ var CozyClient = /*#__PURE__*/function () {
               case 24:
                 _context8.prev = 24;
                 _context8.t0 = _context8["catch"](15);
-                this.dispatch((0, _store.receiveQueryError)(queryId, _context8.t0));
+                this.dispatch((0, _store.receiveQueryError)(queryId, _context8.t0)); // specific onError
+
+                if (!options.onError) {
+                  _context8.next = 31;
+                  break;
+                }
+
+                options.onError(_context8.t0); // defaulted onError
+
+                _context8.next = 36;
+                break;
+
+              case 31:
+                if (!this.options.onError) {
+                  _context8.next = 35;
+                  break;
+                }
+
+                this.options.onError(_context8.t0);
+                _context8.next = 36;
+                break;
+
+              case 35:
                 throw _context8.t0;
 
-              case 28:
+              case 36:
               case "end":
                 return _context8.stop();
             }
@@ -2256,6 +2278,21 @@ var CozyClient = /*#__PURE__*/function () {
         }));
       });
     }
+    /**
+     * At any time put an error function
+     *
+     * @param {Function} [onError] - Set a callback for queries which are errored
+     */
+
+  }, {
+    key: "setOnError",
+    value: function setOnError(onError) {
+      if (this.options && this.options.onError) {
+        throw new Error('On Error is already defined');
+      }
+
+      this.options.onError = onError;
+    }
   }, {
     key: "toJSON",
     value: function toJSON() {
@@ -2415,7 +2452,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.3.2";
+CozyClient.version = "27.6.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/CozyClient.spec.js

@@ -162,7 +162,6 @@ describe('CozyClient initialization', () => {
       })
     }
     const client = await CozyClient.fromOldOAuthClient(oldClient)
-    console.log({ stackClient: client.stackClient })
     expect(client.stackClient.uri).toBe(url)
     expect(client.stackClient.oauthOptions.clientID).toBe(oauth.clientID)
     expect(client.stackClient.token.accessToken).toBe(token.accessToken)
@@ -1402,6 +1401,54 @@ describe('CozyClient', () => {
         receiveQueryResult('allTodos', fakeResponse)
       )
     })
+
+    const setupOnError = () => {
+      const error = new TypeError('Failed to fetch')
+      requestHandler.mockReturnValueOnce(Promise.reject(error))
+      const onError = jest.fn().mockReturnValueOnce(() => true)
+      return onError
+    }
+
+    it('should call onError callback when an error is thrown. Callback passed as argument', async () => {
+      const onError = setupOnError()
+
+      await client.query(query, { as: 'allTodos', onError })
+      expect(onError).toBeCalled()
+    })
+
+    it('should call onError callback when an error is catched. It is passed during instantiation', async () => {
+      const onError = setupOnError()
+      const client = new CozyClient({ onError })
+
+      await client.query(query, { as: 'allTodos' })
+      expect(onError).toBeCalled()
+    })
+
+    it('should call onError callback when an error is catched. It is passed with setOnError', async () => {
+      const onError = setupOnError()
+      client.setOnError(onError)
+
+      await client.query(query, { as: 'allTodos' })
+      expect(onError).toBeCalled()
+    })
+
+    it('should throw an error when we call setOnError twice (or several times)', async () => {
+      const client = new CozyClient({})
+      const onError = () => true
+
+      const funcShouldThrow = () => client.setOnError(onError)
+      expect(funcShouldThrow).not.toThrow()
+      expect(funcShouldThrow).toThrow('On Error is already defined')
+    })
+
+    it('should throw an error when there is no onError callback', async () => {
+      const error = new TypeError('Failed to fetch')
+      requestHandler.mockReturnValueOnce(Promise.reject(error))
+
+      await expect(client.query(query, { as: 'allTodos' })).rejects.toThrow(
+        'Failed to fetch'
+      )
+    })
   })
 
   describe('queryAll', () => {

package/dist/associations/helpers.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.create = exports.resolveClass = exports.attachRelationships = exports.responseToRelationship = exports.pickTypeAndId = void 0;
+exports.getReferencedById = exports.getReferencedBy = exports.isReferencedById = exports.isReferencedBy = exports.create = exports.resolveClass = exports.attachRelationships = exports.responseToRelationship = exports.pickTypeAndId = void 0;
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
@@ -25,6 +25,8 @@ var _HasManyInPlace = _interopRequireDefault(require("./HasManyInPlace"));
 
 var _HasManyFiles = _interopRequireDefault(require("./HasManyFiles"));
 
+var _types = require("../types");
+
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
@@ -124,5 +126,83 @@ var create = function create(target, _ref, accessors) {
 
   return new type(target, name, doctype, accessors);
 };
+/**
+ * Checks if the file is referenced by a specific doctype
+ *
+ * @param {IOCozyFile} file - io.cozy.files document
+ * @param {Doctype} referencedBy - Doctype where document is referenced
+ * @returns {boolean} If a reference is found
+ */
+
+
+exports.create = create;
+
+var isReferencedBy = function isReferencedBy(file, referencedBy) {
+  var _file$relationships, _file$relationships$r;
+
+  var references = (file === null || file === void 0 ? void 0 : (_file$relationships = file.relationships) === null || _file$relationships === void 0 ? void 0 : (_file$relationships$r = _file$relationships.referenced_by) === null || _file$relationships$r === void 0 ? void 0 : _file$relationships$r.data) || (file === null || file === void 0 ? void 0 : file.referenced_by) || [];
+  return references.some(function (reference) {
+    return reference.type === referencedBy;
+  });
+};
+/**
+ * Checks if the file is referenced by a specific doctype and a specific Id of that reference
+ *
+ * @param {IOCozyFile} file - io.cozy.files document
+ * @param {Doctype} referencedBy - Doctype where document is referenced
+ * @param {string} referencedId - Id of the referenced document
+ * @returns {boolean} If a reference is found
+ */
+
+
+exports.isReferencedBy = isReferencedBy;
+
+var isReferencedById = function isReferencedById(file, referencedBy, referencedId) {
+  var _file$relationships2, _file$relationships2$;
+
+  var references = (file === null || file === void 0 ? void 0 : (_file$relationships2 = file.relationships) === null || _file$relationships2 === void 0 ? void 0 : (_file$relationships2$ = _file$relationships2.referenced_by) === null || _file$relationships2$ === void 0 ? void 0 : _file$relationships2$.data) || (file === null || file === void 0 ? void 0 : file.referenced_by) || [];
+  return references.some(function (reference) {
+    return reference.type === referencedBy && reference.id === referencedId;
+  });
+};
+/**
+ * Get array of reference by an specific doctype
+ *
+ * @param {IOCozyFile} file - io.cozy.files document
+ * @param {Doctype} referencedBy - Doctype where document is referenced
+ * @returns {Reference[]} Array of references found
+ */
+
+
+exports.isReferencedById = isReferencedById;
+
+var getReferencedBy = function getReferencedBy(file, referencedBy) {
+  var _file$relationships3, _file$relationships3$;
+
+  var references = (file === null || file === void 0 ? void 0 : (_file$relationships3 = file.relationships) === null || _file$relationships3 === void 0 ? void 0 : (_file$relationships3$ = _file$relationships3.referenced_by) === null || _file$relationships3$ === void 0 ? void 0 : _file$relationships3$.data) || (file === null || file === void 0 ? void 0 : file.referenced_by) || [];
+  return references.filter(function (reference) {
+    return reference.type === referencedBy;
+  });
+};
+/**
+ * Get array of reference by an specific doctype and a specific Id of that reference
+ *
+ * @param {IOCozyFile} file - io.cozy.files document
+ * @param {Doctype} referencedBy - Doctype where document is referenced
+ * @param {string} referencedId - Id of the referenced document
+ * @returns {Reference[]} Array of the reference found
+ */
+
+
+exports.getReferencedBy = getReferencedBy;
+
+var getReferencedById = function getReferencedById(file, referencedBy, referencedId) {
+  var _file$relationships4, _file$relationships4$;
+
+  var references = (file === null || file === void 0 ? void 0 : (_file$relationships4 = file.relationships) === null || _file$relationships4 === void 0 ? void 0 : (_file$relationships4$ = _file$relationships4.referenced_by) === null || _file$relationships4$ === void 0 ? void 0 : _file$relationships4$.data) || (file === null || file === void 0 ? void 0 : file.referenced_by) || [];
+  return references.filter(function (reference) {
+    return reference.type === referencedBy && reference.id === referencedId;
+  });
+};
 
-exports.create = create;
+exports.getReferencedById = getReferencedById;

package/dist/associations/helpers.spec.js

@@ -1,123 +1,237 @@
-import { attachRelationships } from './helpers'
-
-describe('Attaching relationships', () => {
-  const tasks = {
-    data: [
-      { _id: 1, _type: 'io.cozy.tasks' },
-      { _id: 2, _type: 'io.cozy.tasks' }
-    ]
-  }
-  const todos = {
-    data: [
-      { _id: 3, _type: 'io.cozy.todos' },
-      { _id: 4, _type: 'io.cozy.todos' }
-    ]
-  }
-
-  it('should attach to a single document', () => {
-    const doc = {
-      _id: 1
+import {
+  attachRelationships,
+  isReferencedBy,
+  isReferencedById,
+  getReferencedBy,
+  getReferencedById
+} from './helpers'
+
+describe('Associations helpers', () => {
+  describe('Attaching relationships', () => {
+    const tasks = {
+      data: [
+        { _id: 1, _type: 'io.cozy.tasks' },
+        { _id: 2, _type: 'io.cozy.tasks' }
+      ]
     }
-    const relationships = {
-      1: {
-        tasks
-      }
+    const todos = {
+      data: [
+        { _id: 3, _type: 'io.cozy.todos' },
+        { _id: 4, _type: 'io.cozy.todos' }
+      ]
     }
-    const withRelationships = attachRelationships({ data: doc }, relationships)
-    expect(withRelationships.data.relationships).toEqual({
-      tasks
-    })
-  })
 
-  it('should attach to multiple document', () => {
-    const docs = [
-      {
+    it('should attach to a single document', () => {
+      const doc = {
         _id: 1
-      },
-      {
-        _id: 2
       }
-    ]
-    const relationships = {
-      1: {
+      const relationships = {
+        1: {
+          tasks
+        }
+      }
+      const withRelationships = attachRelationships(
+        { data: doc },
+        relationships
+      )
+      expect(withRelationships.data.relationships).toEqual({
         tasks
-      },
-      2: {
-        todos
+      })
+    })
+
+    it('should attach to multiple document', () => {
+      const docs = [
+        {
+          _id: 1
+        },
+        {
+          _id: 2
+        }
+      ]
+      const relationships = {
+        1: {
+          tasks
+        },
+        2: {
+          todos
+        }
       }
-    }
-    const withRelationships = attachRelationships({ data: docs }, relationships)
-    expect(withRelationships.data[0].relationships).toEqual({
-      tasks
+      const withRelationships = attachRelationships(
+        { data: docs },
+        relationships
+      )
+      expect(withRelationships.data[0].relationships).toEqual({
+        tasks
+      })
+      expect(withRelationships.data[1].relationships).toEqual({
+        todos
+      })
     })
-    expect(withRelationships.data[1].relationships).toEqual({
-      todos
+
+    it('should add missing relationships', () => {
+      const doc = {
+        _id: 1,
+        relationships: {
+          tasks
+        }
+      }
+      const relationships = {
+        1: {
+          tasks,
+          todos
+        }
+      }
+      const withRelationships = attachRelationships(
+        { data: doc },
+        relationships
+      )
+      expect(withRelationships.data.relationships.tasks).toEqual(tasks)
+      expect(withRelationships.data.relationships.todos).toEqual(todos)
     })
-  })
 
-  it('should add missing relationships', () => {
-    const doc = {
-      _id: 1,
-      relationships: {
-        tasks
+    it('should preserve existing relationships', () => {
+      const doc = {
+        _id: 1,
+        relationships: {
+          tasks
+        }
       }
-    }
-    const relationships = {
-      1: {
-        tasks,
-        todos
+      const relationships = {
+        1: {
+          todos
+        }
       }
-    }
-    const withRelationships = attachRelationships({ data: doc }, relationships)
-    expect(withRelationships.data.relationships.tasks).toEqual(tasks)
-    expect(withRelationships.data.relationships.todos).toEqual(todos)
-  })
+      const withRelationships = attachRelationships(
+        { data: doc },
+        relationships
+      )
+      expect(withRelationships.data.relationships.tasks).toEqual(tasks)
+      expect(withRelationships.data.relationships.todos).toEqual(todos)
+    })
 
-  it('should preserve existing relationships', () => {
-    const doc = {
-      _id: 1,
-      relationships: {
-        tasks
+    it('should work when there are no new relationships', () => {
+      const doc = {
+        _id: 1,
+        relationships: {
+          tasks
+        }
       }
-    }
-    const relationships = {
-      1: {
-        todos
+      const relationships = {
+        2: {
+          todos
+        }
       }
-    }
-    const withRelationships = attachRelationships({ data: doc }, relationships)
-    expect(withRelationships.data.relationships.tasks).toEqual(tasks)
-    expect(withRelationships.data.relationships.todos).toEqual(todos)
-  })
+      const withRelationships = attachRelationships(
+        { data: doc },
+        relationships
+      )
+      expect(withRelationships.data.relationships.tasks).toEqual(tasks)
+      expect(Object.keys(withRelationships.data.relationships).length).toEqual(
+        1
+      )
+    })
 
-  it('should work when there are no new relationships', () => {
-    const doc = {
-      _id: 1,
-      relationships: {
-        tasks
+    it('should attach relationships when the document has an empty relationship object', () => {
+      const doc = {
+        _id: 1,
+        relationships: {}
       }
-    }
-    const relationships = {
-      2: {
-        todos
+      const relationships = {
+        1: {
+          tasks
+        }
       }
-    }
-    const withRelationships = attachRelationships({ data: doc }, relationships)
-    expect(withRelationships.data.relationships.tasks).toEqual(tasks)
-    expect(Object.keys(withRelationships.data.relationships).length).toEqual(1)
+      const withRelationships = attachRelationships(
+        { data: doc },
+        relationships
+      )
+      expect(withRelationships.data.relationships.tasks).toEqual(tasks)
+    })
   })
 
-  it('should attach relationships when the document has an empty relationship object', () => {
-    const doc = {
-      _id: 1,
-      relationships: {}
-    }
-    const relationships = {
-      1: {
-        tasks
+  describe('referencedBy', () => {
+    const mockFile = {
+      _id: '123',
+      name: 'fakeFile',
+      relationships: {
+        referenced_by: {
+          data: [
+            {
+              id: '123',
+              type: 'io.cozy.contacts'
+            },
+            {
+              id: '456',
+              type: 'io.cozy.contacts'
+            }
+          ]
+        }
       }
     }
-    const withRelationships = attachRelationships({ data: doc }, relationships)
-    expect(withRelationships.data.relationships.tasks).toEqual(tasks)
+    describe('isReferencedBy', () => {
+      it('should return "true"', () => {
+        const result = isReferencedBy(mockFile, 'io.cozy.contacts')
+
+        expect(result).toBe(true)
+      })
+      it('should return "false"', () => {
+        const result = isReferencedBy(mockFile, 'io.cozy.xxx')
+
+        expect(result).toBe(false)
+      })
+    })
+
+    describe('isReferencedById', () => {
+      it('should return "true"', () => {
+        const result = isReferencedById(mockFile, 'io.cozy.contacts', '123')
+
+        expect(result).toBe(true)
+      })
+      it('should return "false"', () => {
+        const result = isReferencedById(mockFile, 'io.cozy.contacts', '789')
+
+        expect(result).toBe(false)
+      })
+    })
+
+    describe('getReferencedBy', () => {
+      it('should return correct array of reference', () => {
+        const result = getReferencedBy(mockFile, 'io.cozy.contacts')
+
+        expect(result).toEqual([
+          {
+            id: '123',
+            type: 'io.cozy.contacts'
+          },
+          {
+            id: '456',
+            type: 'io.cozy.contacts'
+          }
+        ])
+      })
+      it('should return empty array', () => {
+        const result = getReferencedBy(mockFile, 'io.cozy.xxx')
+
+        expect(result).toEqual([])
+      })
+    })
+
+    describe('getReferencedById', () => {
+      it('should return array of reference with only the reference with id "123"', () => {
+        const result = getReferencedById(mockFile, 'io.cozy.contacts', '123')
+
+        expect(result).toEqual([
+          {
+            id: '123',
+            type: 'io.cozy.contacts'
+          }
+        ])
+      })
+      it('should return empty array', () => {
+        const result = getReferencedById(mockFile, 'io.cozy.contacts', '789')
+
+        expect(result).toEqual([])
+      })
+    })
   })
 })

package/dist/associations/index.js

@@ -59,6 +59,30 @@ Object.defineProperty(exports, "create", {
     return _helpers.create;
   }
 });
+Object.defineProperty(exports, "isReferencedBy", {
+  enumerable: true,
+  get: function get() {
+    return _helpers.isReferencedBy;
+  }
+});
+Object.defineProperty(exports, "isReferencedById", {
+  enumerable: true,
+  get: function get() {
+    return _helpers.isReferencedById;
+  }
+});
+Object.defineProperty(exports, "getReferencedBy", {
+  enumerable: true,
+  get: function get() {
+    return _helpers.getReferencedBy;
+  }
+});
+Object.defineProperty(exports, "getReferencedById", {
+  enumerable: true,
+  get: function get() {
+    return _helpers.getReferencedById;
+  }
+});
 
 var _HasManyFiles = _interopRequireDefault(require("./HasManyFiles"));