cozy-client 27.4.0 → 27.5.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [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)
 
 

package/dist/CozyClient.js

@@ -2452,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.4.0";
+CozyClient.version = "27.5.0";
 
 _microee.default.mixin(CozyClient);
 

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"));
 

package/dist/types.js

@@ -99,12 +99,32 @@ var _dsl = require("./queries/dsl");
  */
 
 /**
- * A reference to a document (special case of a relationship used between photos and albums)
+ * A reference to a document
+ *
+ * @typedef {object} ReferencedByRelationship
+ * @property {RelationshipParent} [parent]
+ * @property {ReferencedBy} [referenced_by]
+ */
+
+/**
+ * @typedef {object} RelationshipParent
+ * @property {{related: string}} links
+ * @property {Reference} [data]
+ */
+
+/**
+ * @typedef {object} ReferencedBy
+ * @property {{self: string}} links
+ * @property {Reference[]|null} data
+ */
+
+/**
+ * A reference to a document
  * https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.files/#references
  *
  * @typedef {object} Reference
- * @property {string} _id - id of the document
- * @property {string} _type - doctype of the document
+ * @property {string} id - id of the document
+ * @property {string} type - doctype of the document
  */
 
 /**
@@ -125,7 +145,8 @@ var _dsl = require("./queries/dsl");
  * @property {string} [_type] - Type of the document
  * @property {string} [_rev] - Current revision of the document
  * @property {boolean} [_deleted] - When the document has been deleted
- * @property {object} [relationships] - Relationships of the document
+ * @property {ReferencedByRelationship} [relationships] - Relationships of the document
+ * @property {Reference[]} [referenced_by] - referenced by of another document
  */
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "27.4.0",
+  "version": "27.5.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -69,5 +69,5 @@
     "react-native-inappbrowser-reborn": "^3.5.1"
   },
   "sideEffects": false,
-  "gitHead": "1ab42dff2e9088f4a3daff29866ad7a22b093791"
+  "gitHead": "4d49dc4e8d6fcb949cc5d28b5bc1f5bda126560d"
 }

package/types/associations/helpers.d.ts

@@ -7,3 +7,10 @@ export function create(target: any, { name, type, doctype }: {
     type: any;
     doctype: any;
 }, accessors: any): any;
+export function isReferencedBy(file: IOCozyFile, referencedBy: Doctype): boolean;
+export function isReferencedById(file: IOCozyFile, referencedBy: Doctype, referencedId: string): boolean;
+export function getReferencedBy(file: IOCozyFile, referencedBy: Doctype): Reference[];
+export function getReferencedById(file: IOCozyFile, referencedBy: Doctype, referencedId: string): Reference[];
+import { IOCozyFile } from "../types";
+import { Doctype } from "../types";
+import { Reference } from "../types";

package/types/associations/index.d.ts

@@ -6,4 +6,4 @@ import HasOneInPlace from "./HasOneInPlace";
 import HasManyInPlace from "./HasManyInPlace";
 import HasManyTriggers from "./HasManyTriggers";
 export { Association, HasManyFiles, HasMany, HasOne, HasOneInPlace, HasManyInPlace, HasManyTriggers };
-export { resolveClass, create } from "./helpers";
+export { resolveClass, create, isReferencedBy, isReferencedById, getReferencedBy, getReferencedById } from "./helpers";

package/types/queries/referencedBy.d.ts

@@ -0,0 +1,7 @@
+export function isReferencedBy(file: IOCozyFile, referencedBy: Doctype): boolean;
+export function isReferencedById(file: IOCozyFile, referencedBy: Doctype, referencedId: string): boolean;
+export function getReferencedBy(file: IOCozyFile, referencedBy: Doctype): Reference[];
+export function getReferencedById(file: IOCozyFile, referencedBy: Doctype, referencedId: string): Reference[];
+import { IOCozyFile } from "../types";
+import { Doctype } from "../types";
+import { Reference } from "../types";

package/types/types.d.ts

@@ -74,18 +74,37 @@ export type FetchMoreAble = {
 };
 export type UseQueryReturnValue = QueryState & FetchMoreAble;
 /**
- * A reference to a document (special case of a relationship used between photos and albums)
+ * A reference to a document
+ */
+export type ReferencedByRelationship = {
+    parent?: RelationshipParent;
+    referenced_by?: ReferencedBy;
+};
+export type RelationshipParent = {
+    links: {
+        related: string;
+    };
+    data?: Reference;
+};
+export type ReferencedBy = {
+    links: {
+        self: string;
+    };
+    data: Reference[] | null;
+};
+/**
+ * A reference to a document
  * https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.files/#references
  */
 export type Reference = {
     /**
      * - id of the document
      */
-    _id: string;
+    id: string;
     /**
      * - doctype of the document
      */
-    _type: string;
+    type: string;
 };
 export type ReferenceMap = {
     [x: string]: Reference[];
@@ -122,7 +141,11 @@ export type CozyClientDocument = {
     /**
      * - Relationships of the document
      */
-    relationships?: object;
+    relationships?: ReferencedByRelationship;
+    /**
+     * - referenced by of another document
+     */
+    referenced_by?: Reference[];
 };
 /**
  * - An io.cozy.files document