cozy-client 34.4.0 → 34.6.0

package/dist/CozyClient.js

@@ -2644,7 +2644,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 = "34.4.0";
+CozyClient.version = "34.6.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/models/paper.js

@@ -16,6 +16,11 @@ var _sub = _interopRequireDefault(require("date-fns/sub"));
  */
 var PERSONAL_SPORTING_LICENCE_PERIOD_DAYS = 365;
 var PERSONAL_SPORTING_LICENCE_NOTICE_PERIOD_DAYS = 15;
+var EXPIRATION_LINK_BY_LABEL = {
+  national_id_card: 'https://www.service-public.fr/particuliers/vosdroits/N358',
+  residence_permit: 'https://www.service-public.fr/particuliers/vosdroits/N110',
+  passport: 'https://www.service-public.fr/particuliers/vosdroits/N360'
+};
 /**
  * @param {IOCozyFile} file - io.cozy.files document
  * @returns {boolean}
@@ -39,18 +44,17 @@ var isExpiringFrenchNationalIdCard = function isExpiringFrenchNationalIdCard(fil
 /**
  * @param {IOCozyFile} file - io.cozy.files document
  * @returns {boolean}
- * @description Tells if a given file is a residence permit, has an expiration date set and a notice period set
+ * @description Tells if a given file has an expiration date set and a notice period set
  */
 
 
-var isExpiringResidencePermit = function isExpiringResidencePermit(file) {
-  var _file$metadata5, _file$metadata5$quali, _file$metadata6, _file$metadata7;
+var isExpiringGeneric = function isExpiringGeneric(file) {
+  var _file$metadata5, _file$metadata6;
 
-  var label = (_file$metadata5 = file.metadata) === null || _file$metadata5 === void 0 ? void 0 : (_file$metadata5$quali = _file$metadata5.qualification) === null || _file$metadata5$quali === void 0 ? void 0 : _file$metadata5$quali.label;
-  var expirationDate = (_file$metadata6 = file.metadata) === null || _file$metadata6 === void 0 ? void 0 : _file$metadata6.expirationDate;
-  var noticePeriod = (_file$metadata7 = file.metadata) === null || _file$metadata7 === void 0 ? void 0 : _file$metadata7.noticePeriod;
+  var expirationDate = (_file$metadata5 = file.metadata) === null || _file$metadata5 === void 0 ? void 0 : _file$metadata5.expirationDate;
+  var noticePeriod = (_file$metadata6 = file.metadata) === null || _file$metadata6 === void 0 ? void 0 : _file$metadata6.noticePeriod;
 
-  if (label === 'residence_permit' && expirationDate && noticePeriod) {
+  if (expirationDate && noticePeriod) {
     return true;
   }
 
@@ -64,10 +68,10 @@ var isExpiringResidencePermit = function isExpiringResidencePermit(file) {
 
 
 var isExpiringPersonalSportingLicense = function isExpiringPersonalSportingLicense(file) {
-  var _file$metadata8, _file$metadata8$quali, _file$metadata9;
+  var _file$metadata7, _file$metadata7$quali, _file$metadata8;
 
-  var label = (_file$metadata8 = file.metadata) === null || _file$metadata8 === void 0 ? void 0 : (_file$metadata8$quali = _file$metadata8.qualification) === null || _file$metadata8$quali === void 0 ? void 0 : _file$metadata8$quali.label;
-  var referencedDate = (_file$metadata9 = file.metadata) === null || _file$metadata9 === void 0 ? void 0 : _file$metadata9.referencedDate;
+  var label = (_file$metadata7 = file.metadata) === null || _file$metadata7 === void 0 ? void 0 : (_file$metadata7$quali = _file$metadata7.qualification) === null || _file$metadata7$quali === void 0 ? void 0 : _file$metadata7$quali.label;
+  var referencedDate = (_file$metadata8 = file.metadata) === null || _file$metadata8 === void 0 ? void 0 : _file$metadata8.referencedDate;
   var created_at = file.created_at;
 
   if (label === 'personal_sporting_licence' && (referencedDate || created_at)) {
@@ -88,7 +92,7 @@ var isExpiring = function isExpiring(file) {
     return true;
   }
 
-  if (isExpiringResidencePermit(file)) {
+  if (isExpiringGeneric(file)) {
     return true;
   }
 
@@ -108,17 +112,17 @@ var isExpiring = function isExpiring(file) {
 exports.isExpiring = isExpiring;
 
 var computeExpirationDate = function computeExpirationDate(file) {
-  if (isExpiringFrenchNationalIdCard(file) || isExpiringResidencePermit(file)) {
-    var _file$metadata10;
+  if (isExpiringFrenchNationalIdCard(file) || isExpiringGeneric(file)) {
+    var _file$metadata9;
 
-    var expirationDate = (_file$metadata10 = file.metadata) === null || _file$metadata10 === void 0 ? void 0 : _file$metadata10.expirationDate;
+    var expirationDate = (_file$metadata9 = file.metadata) === null || _file$metadata9 === void 0 ? void 0 : _file$metadata9.expirationDate;
     return new Date(expirationDate);
   }
 
   if (isExpiringPersonalSportingLicense(file)) {
-    var _file$metadata11;
+    var _file$metadata10;
 
-    var referencedDate = (_file$metadata11 = file.metadata) === null || _file$metadata11 === void 0 ? void 0 : _file$metadata11.referencedDate;
+    var referencedDate = (_file$metadata10 = file.metadata) === null || _file$metadata10 === void 0 ? void 0 : _file$metadata10.referencedDate;
     var created_at = file.created_at;
     return (0, _add.default)(new Date(referencedDate !== null && referencedDate !== void 0 ? referencedDate : created_at), {
       days: PERSONAL_SPORTING_LICENCE_PERIOD_DAYS
@@ -137,10 +141,10 @@ var computeExpirationDate = function computeExpirationDate(file) {
 exports.computeExpirationDate = computeExpirationDate;
 
 var computeExpirationNoticePeriodInDays = function computeExpirationNoticePeriodInDays(file) {
-  if (isExpiringFrenchNationalIdCard(file) || isExpiringResidencePermit(file)) {
-    var _file$metadata12;
+  if (isExpiringFrenchNationalIdCard(file) || isExpiringGeneric(file)) {
+    var _file$metadata11;
 
-    var noticePeriodInDays = (_file$metadata12 = file.metadata) === null || _file$metadata12 === void 0 ? void 0 : _file$metadata12.noticePeriod;
+    var noticePeriodInDays = (_file$metadata11 = file.metadata) === null || _file$metadata11 === void 0 ? void 0 : _file$metadata11.noticePeriod;
     return parseInt(noticePeriodInDays, 10);
   }
 
@@ -177,22 +181,18 @@ var computeExpirationNoticeDate = function computeExpirationNoticeDate(file) {
 /**
  * @param {IOCozyFile} file - io.cozy.files document
  * @returns {string | null} Expiration notice link
- * @description Computes et returns the expiration notice link of the given file, or null if it has none or it is not expiring
+ * @description Computes and returns the expiration notice link of the given file, or null if it has none
  */
 
 
 exports.computeExpirationNoticeDate = computeExpirationNoticeDate;
 
 var computeExpirationNoticeLink = function computeExpirationNoticeLink(file) {
-  if (isExpiringFrenchNationalIdCard(file)) {
-    return 'https://www.service-public.fr/particuliers/vosdroits/N358';
-  }
+  var _file$metadata12, _file$metadata12$qual;
 
-  if (isExpiringResidencePermit(file)) {
-    return 'https://www.service-public.fr/particuliers/vosdroits/N110';
-  }
-
-  return null;
+  var qualificationLabel = (_file$metadata12 = file.metadata) === null || _file$metadata12 === void 0 ? void 0 : (_file$metadata12$qual = _file$metadata12.qualification) === null || _file$metadata12$qual === void 0 ? void 0 : _file$metadata12$qual.label;
+  if (!qualificationLabel) return null;
+  return EXPIRATION_LINK_BY_LABEL[qualificationLabel] || null;
 };
 /**
  * @param {IOCozyFile} file - io.cozy.files document

package/dist/models/paper.spec.js

@@ -2,6 +2,32 @@ import MockDate from 'mockdate'
 
 import * as paperModel from './paper'
 
+/**
+ *
+ * @param {object} param - options
+ * @param {string} param.qualificationLabel - qualification label
+ * @param {string} [param.expirationDate] - expiration date of file
+ * @param {string} [param.referencedDate] - reference date of file
+ * @param {string} [param.noticePeriod] - period before send notification
+ */
+const buildMockFile = ({
+  qualificationLabel,
+  expirationDate,
+  referencedDate,
+  noticePeriod
+}) => {
+  return /** @type {import('../types').IOCozyFile} */ ({
+    name: qualificationLabel,
+    created_at: '2022-09-01T00:00:00.000Z',
+    metadata: {
+      qualification: { label: qualificationLabel },
+      ...(expirationDate && { expirationDate }),
+      ...(referencedDate && { referencedDate }),
+      ...(noticePeriod && { noticePeriod })
+    }
+  })
+}
+
 describe('Expiration', () => {
   beforeEach(() => {
     MockDate.set('2022-11-01T11:35:58.118Z')
@@ -10,44 +36,46 @@ describe('Expiration', () => {
     MockDate.reset()
   })
 
-  const fakeFile01 = {
-    _id: '01',
-    name: 'national id card',
-    created_at: '2022-09-01T00:00:00.000Z',
-    metadata: {
-      qualification: { label: 'national_id_card' },
-      expirationDate: '2022-09-23T11:35:58.118Z',
-      noticePeriod: '90'
-    }
-  }
-  const fakeFile02 = {
-    _id: '02',
-    name: 'personal sporting licence',
-    created_at: '2022-09-01T00:00:00.000Z',
-    metadata: {
-      qualification: { label: 'personal_sporting_licence' },
-      referencedDate: '2022-09-23T11:35:58.118Z'
-    }
-  }
-  const fakeFile03 = {
-    _id: '03',
+  const fakeFileWithoutMetadata = /** @type {import('../types').IOCozyFile} */ ({
+    _id: '00',
     name: 'unknown'
-  }
+  })
+  const fakeNationalIdCardFile = buildMockFile({
+    qualificationLabel: 'national_id_card',
+    expirationDate: '2022-09-23T11:35:58.118Z',
+    noticePeriod: '90'
+  })
+  const fakePassportFile = buildMockFile({
+    qualificationLabel: 'passport',
+    expirationDate: '2022-09-23T11:35:58.118Z',
+    noticePeriod: '90'
+  })
+  const fakePersonalSportingLicenceFile = buildMockFile({
+    qualificationLabel: 'personal_sporting_licence',
+    referencedDate: '2022-09-23T11:35:58.118Z'
+  })
+  const fakeResidencePermitFile = buildMockFile({
+    qualificationLabel: 'residence_permit',
+    expirationDate: '2022-09-23T11:35:58.118Z',
+    noticePeriod: '90'
+  })
 
   describe('computeExpirationDate', () => {
     it('should return expirationDate', () => {
-      const res = paperModel.computeExpirationDate(fakeFile01)
+      const res = paperModel.computeExpirationDate(fakeNationalIdCardFile)
 
       expect(res.toISOString()).toBe('2022-09-23T11:35:58.118Z')
     })
     it('should return referencedDate plus 365 days', () => {
-      const res = paperModel.computeExpirationDate(fakeFile02)
+      const res = paperModel.computeExpirationDate(
+        fakePersonalSportingLicenceFile
+      )
 
       expect(res.toISOString()).toBe('2023-09-23T11:35:58.118Z')
     })
 
     it('should return "null" if metadata is not found', () => {
-      const res = paperModel.computeExpirationDate(fakeFile03)
+      const res = paperModel.computeExpirationDate(fakeFileWithoutMetadata)
 
       expect(res).toBeNull()
     })
@@ -55,19 +83,94 @@ describe('Expiration', () => {
 
   describe('computeExpirationNoticeDate', () => {
     it('should return notice date for file with expirationDate metadata', () => {
-      const res = paperModel.computeExpirationNoticeDate(fakeFile01)
+      const res = paperModel.computeExpirationNoticeDate(fakeNationalIdCardFile)
 
       expect(res.toISOString()).toBe('2022-06-25T11:35:58.118Z')
     })
     it('should return notice date for file with referencedDate metadata', () => {
-      const res = paperModel.computeExpirationNoticeDate(fakeFile02)
+      const res = paperModel.computeExpirationNoticeDate(
+        fakePersonalSportingLicenceFile
+      )
 
       expect(res.toISOString()).toBe('2023-09-08T11:35:58.118Z')
     })
     it('should return null for file without corresponding metadata', () => {
-      const res = paperModel.computeExpirationNoticeDate(fakeFile03)
+      const res = paperModel.computeExpirationNoticeDate(
+        fakeFileWithoutMetadata
+      )
 
       expect(res).toBeNull()
     })
   })
+
+  describe('computeExpirationNoticeLink', () => {
+    it.each`
+      file                       | link
+      ${fakeNationalIdCardFile}  | ${'https://www.service-public.fr/particuliers/vosdroits/N358'}
+      ${fakeResidencePermitFile} | ${'https://www.service-public.fr/particuliers/vosdroits/N110'}
+      ${fakePassportFile}        | ${'https://www.service-public.fr/particuliers/vosdroits/N360'}
+    `(
+      `should return "$link" link for an file with "$file.metadata.qualification.label" qualification label`,
+      ({ file, link }) => {
+        expect(paperModel.computeExpirationNoticeLink(file)).toEqual(link)
+      }
+    )
+  })
+
+  describe('isExpiring', () => {
+    const fakeNationalIdCardFileWithoutNoticeDate = buildMockFile({
+      qualificationLabel: 'national_id_card',
+      expirationDate: '2022-09-23T11:35:58.118Z',
+      noticePeriod: ''
+    })
+    const fakeResidencePermitFileWithoutNoticeDate = buildMockFile({
+      qualificationLabel: 'residence_permit',
+      expirationDate: '2022-09-23T11:35:58.118Z',
+      noticePeriod: ''
+    })
+    const fakeNationalIdCardFileWithoutExpirationDate = buildMockFile({
+      qualificationLabel: 'national_id_card',
+      expirationDate: '',
+      noticePeriod: '90'
+    })
+    const fakeResidencePermitFileWithoutExpirationDate = buildMockFile({
+      qualificationLabel: 'residence_permit',
+      expirationDate: '',
+      noticePeriod: '90'
+    })
+
+    it.each`
+      file                               | result
+      ${fakeNationalIdCardFile}          | ${true}
+      ${fakePersonalSportingLicenceFile} | ${true}
+      ${fakeResidencePermitFile}         | ${true}
+    `(
+      `should return "$result" for each file with "noticePeriod" & "expirationDate" metadata`,
+      ({ file, result }) => {
+        expect(paperModel.isExpiring(file)).toEqual(result)
+      }
+    )
+
+    it.each`
+      file                                        | result
+      ${fakeNationalIdCardFileWithoutNoticeDate}  | ${false}
+      ${fakeResidencePermitFileWithoutNoticeDate} | ${false}
+    `(
+      `should return "$result" for each file without "noticePeriod" metadata`,
+      ({ file, result }) => {
+        expect(paperModel.isExpiring(file)).toEqual(result)
+      }
+    )
+
+    it.each`
+      file                                            | result
+      ${fakeNationalIdCardFileWithoutExpirationDate}  | ${false}
+      ${fakeResidencePermitFileWithoutExpirationDate} | ${false}
+    `(
+      `should return "$result" for each file without "expirationDate" metadata`,
+      ({ file, result }) => {
+        expect(paperModel.isExpiring(file)).toEqual(result)
+      }
+    )
+  })
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "34.4.0",
+  "version": "34.6.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -73,5 +73,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "2810ff3f07087a335e8576aebd88f48594821e62"
+  "gitHead": "ef938fae49072daffdb9e2b7228306212483b54c"
 }