cozy-client 45.14.0 → 45.15.0

package/dist/CozyClient.js

@@ -2705,7 +2705,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 = "45.14.0";
+CozyClient.version = "45.15.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/Provider.js

@@ -82,7 +82,7 @@ exports.default = CozyProvider;
 (0, _defineProperty2.default)(CozyProvider, "propTypes", {
   store: storePropType,
   client: _propTypes.default.object.isRequired,
-  children: _propTypes.default.element.isRequired
+  children: _propTypes.default.oneOfType([_propTypes.default.element, _propTypes.default.arrayOf(_propTypes.default.element)]).isRequired
 });
 (0, _defineProperty2.default)(CozyProvider, "childContextTypes", {
   store: _propTypes.default.object,

package/dist/models/document/locales/en.json

@@ -148,6 +148,89 @@
       "transport": "Transport",
       "undefined": "Undefined",
       "work_study": "Work & Study"
+    },
+    "qualification": {
+      "date": {
+        "title": {
+          "datetime": "Added on",
+          "AObtentionDate": "License A, delivered on",
+          "BObtentionDate": "License B, delivered on",
+          "CObtentionDate": "License C, delivered on",
+          "DObtentionDate": "License D, delivered on",
+          "issueDate": "Delivered on",
+          "expirationDate": "Expiration date",
+          "referencedDate": "Referenced date",
+          "shootingDate": "Shooting date",
+          "obtentionDate": "Date obtained",
+          "date": "Document date"
+        }
+      },
+      "information": {
+        "title": {
+          "fine": {
+            "number": "Amount of the fine"
+          },
+          "fidelity_card": {
+            "number": "Card number"
+          },
+          "caf": {
+            "number": "CAF file number"
+          },
+          "payment_proof_family_allowance": {
+            "number":"CAF file number"
+          },
+          "vehicle_registration": {
+            "number": "Vehicle registration number (VIN)"
+          },
+          "national_id_card": {
+            "number": "National ID card number"
+          },
+          "bank_details": {
+            "number": "IBAN number"
+          },
+          "passport": {
+            "number": "Passport number"
+          },
+          "driver_license": {
+            "number": "License number"
+          },
+          "residence_permit": {
+            "number": "License number"
+          },
+          "national_health_insurance_card": {
+            "number": "National health insurance card number"
+          },
+          "pay_sheet": {
+            "number": "Gross remuneration"
+          },
+          "tax_return": {
+            "number": "Reference tax number"
+          },
+          "tax_notice": {
+            "number": "Reference tax number"
+          },
+          "real_estate_tax": {
+            "number": "Reference tax number"
+          },
+          "tax_timetable": {
+            "number": "Reference tax number"
+          },
+          "country": "Beneficiary nationality",
+          "refTaxIncome": "Reference tax income",
+          "contractType": "Contract type",
+          "noticePeriod": "Expiration alert",
+          "netSocialAmount": "Net social amount",
+          "employerName": "Name of employer",
+          "bicNumber": "BIC number"
+        },
+        "day": "day |||| days"
+      },
+      "contact": "Owner",
+      "page": "Side of the document",
+      "front": "Front side",
+      "back": "Back side",
+      "qualification": "Qualification",
+      "noInfo": "No information"
     }
   },
   "MagicFolders": {

package/dist/models/document/locales/fr.json

@@ -148,6 +148,89 @@
       "transport": "Transport",
       "undefined": "Indéfini",
       "work_study": "Travail & Études"
+    },
+    "qualification": {
+      "date": {
+        "title": {
+          "datetime": "Ajouté le",
+          "AObtentionDate": "Permis A, délivré le",
+          "BObtentionDate": "Permis B, délivré le",
+          "CObtentionDate": "Permis C, délivré le",
+          "DObtentionDate": "Permis D, délivré le",
+          "issueDate": "Délivré le",
+          "expirationDate": "Date d'expiration",
+          "referencedDate": "Date de référence",
+          "shootingDate": "Date de prise de vue",
+          "obtentionDate": "Date d'obtention",
+          "date": "Date du document"
+        }
+      },
+      "information": {
+        "title": {
+          "fine": {
+            "number": "Montant de l'amende"
+          },
+          "fidelity_card": {
+            "number": "Numéro de la carte"
+          },
+          "caf": {
+            "number": "Numéro de dossier CAF"
+          },
+          "payment_proof_family_allowance": {
+            "number":"Numéro de dossier CAF"
+          },
+          "vehicle_registration": {
+            "number": "Numéro de la carte grise (VIN)"
+          },
+          "national_id_card": {
+            "number": "Numéro de la carte d'identité"
+          },
+          "bank_details": {
+            "number": "Numéro d'IBAN"
+          },
+          "passport": {
+            "number": "Numéro du passeport"
+          },
+          "driver_license": {
+            "number": "Numéro du permis"
+          },
+          "residence_permit": {
+            "number": "Numéro du permis"
+          },
+          "national_health_insurance_card": {
+            "number": "Numéro de la carte vitale"
+          },
+          "pay_sheet": {
+            "number": "Rémunération brute"
+          },
+          "tax_return": {
+            "number": "Numéro fiscal de référence"
+          },
+          "tax_notice": {
+            "number": "Numéro fiscal de référence"
+          },
+          "real_estate_tax": {
+            "number": "Numéro fiscal de référence"
+          },
+          "tax_timetable": {
+            "number": "Numéro fiscal de référence"
+          },
+          "country": "Nationalité du bénéficiaire",
+          "refTaxIncome": "Revenu fiscal de référence",
+          "contractType": "Type de contrat",
+          "noticePeriod": "Alerte d’expiration",
+          "netSocialAmount": "Montant net social",
+          "employerName": "Nom de l'employeur",
+          "bicNumber": "Numéro BIC"
+        },
+        "day": "jour |||| jours"
+      },
+      "contact": "Titulaire",
+      "page": "Face du document",
+      "front": "Face avant",
+      "back": "Face arrière",
+      "qualification": "Qualification",
+      "noInfo": "Non renseigné(e)"
     }
   },
   "MagicFolders": {

package/dist/models/paper.js

@@ -5,12 +5,18 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.isExpiringSoon = exports.isExpired = exports.computeExpirationNoticeLink = exports.computeExpirationNoticeDate = exports.computeExpirationDate = exports.isExpiring = void 0;
+exports.formatContactValue = exports.getTranslatedNameForContact = exports.formatOtherMetadataValue = exports.getTranslatedNameForOtherMetadata = exports.formatInformationMetadataValue = exports.getTranslatedNameForInformationMetadata = exports.formatDateMetadataValue = exports.getTranslatedNameForDateMetadata = exports.getMetadataQualificationType = exports.formatMetadataQualification = exports.isExpiringSoon = exports.isExpired = exports.computeExpirationNoticeLink = exports.computeExpirationNoticeDate = exports.computeExpirationDate = exports.isExpiring = exports.KNOWN_OTHER_METADATA_NAMES = exports.KNOWN_INFORMATION_METADATA_NAMES = exports.KNOWN_DATE_METADATA_NAMES = void 0;
+
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 
 var _add = _interopRequireDefault(require("date-fns/add"));
 
 var _sub = _interopRequireDefault(require("date-fns/sub"));
 
+var _locales = require("./document/locales");
+
+var _contact = require("./contact");
+
 /**
  * @typedef {import("../types").IOCozyFile} IOCozyFile
  */
@@ -22,12 +28,19 @@ var EXPIRATION_LINK_BY_LABEL = {
   passport: 'https://www.service-public.fr/particuliers/vosdroits/N360',
   driver_license: 'https://permisdeconduire.ants.gouv.fr/demarches-en-ligne/perte-vol-deterioration-fin-de-validite-ou-changement-d-etat-civil'
 };
+var KNOWN_DATE_METADATA_NAMES = ['AObtentionDate', 'BObtentionDate', 'CObtentionDate', 'DObtentionDate', 'obtentionDate', 'expirationDate', 'referencedDate', 'issueDate', 'shootingDate', 'date', 'datetime'];
+exports.KNOWN_DATE_METADATA_NAMES = KNOWN_DATE_METADATA_NAMES;
+var KNOWN_INFORMATION_METADATA_NAMES = ['number', 'bicNumber', 'country', 'refTaxIncome', 'contractType', 'netSocialAmount', 'employerName', 'noticePeriod'];
+exports.KNOWN_INFORMATION_METADATA_NAMES = KNOWN_INFORMATION_METADATA_NAMES;
+var KNOWN_OTHER_METADATA_NAMES = ['contact', 'page', 'qualification'];
 /**
  * @param {IOCozyFile} file - io.cozy.files document
  * @returns {boolean}
  * @description Tells if a given file is a national id card, is French, has an expiration date set and has a notice period set
  */
 
+exports.KNOWN_OTHER_METADATA_NAMES = KNOWN_OTHER_METADATA_NAMES;
+
 var isExpiringFrenchNationalIdCard = function isExpiringFrenchNationalIdCard(file) {
   var _file$metadata, _file$metadata$qualif, _file$metadata2, _file$metadata3, _file$metadata4;
 
@@ -227,4 +240,260 @@ var isExpiringSoon = function isExpiringSoon(file) {
   return isExpiringSoon;
 };
 
-exports.isExpiringSoon = isExpiringSoon;
+exports.isExpiringSoon = isExpiringSoon;
+
+var makeMetadataQualification = function makeMetadataQualification(_ref) {
+  var metadata = _ref.metadata,
+      knownMetadataName = _ref.knownMetadataName,
+      value = _ref.value;
+  var shouldReturnThisMetadata = Object.keys(metadata).includes(knownMetadataName);
+
+  if (shouldReturnThisMetadata || knownMetadataName === 'contact') {
+    return {
+      name: knownMetadataName,
+      value: value || null
+    };
+  }
+
+  return null;
+};
+/**
+ * @param {Object} metadata - An io.cozy.files metadata object
+ * @returns {{ name: string, value: string | null }[]} Array of displayable metadata
+ * @description Select and format displayable metadata of a paper
+ */
+
+
+var formatMetadataQualification = function formatMetadataQualification(metadata) {
+  var dates = KNOWN_DATE_METADATA_NAMES.map(function (dateName) {
+    return makeMetadataQualification({
+      metadata: metadata,
+      knownMetadataName: dateName,
+      value: metadata[dateName]
+    });
+  }).filter(Boolean).filter(function (data, _, arr) {
+    if (arr.length > 1) return data.name !== 'datetime';
+    return data;
+  });
+  var informations = KNOWN_INFORMATION_METADATA_NAMES.map(function (numberName) {
+    return makeMetadataQualification({
+      metadata: metadata,
+      knownMetadataName: numberName,
+      value: metadata[numberName]
+    });
+  }).filter(Boolean);
+  var others = KNOWN_OTHER_METADATA_NAMES.map(function (otherName) {
+    var _metadata$otherName;
+
+    var value = otherName === 'qualification' ? (_metadata$otherName = metadata[otherName]) === null || _metadata$otherName === void 0 ? void 0 : _metadata$otherName.label : metadata[otherName];
+    return makeMetadataQualification({
+      metadata: metadata,
+      knownMetadataName: otherName,
+      value: value
+    });
+  }).filter(Boolean);
+  return [].concat((0, _toConsumableArray2.default)(dates), (0, _toConsumableArray2.default)(informations), (0, _toConsumableArray2.default)(others));
+};
+/**
+ * @typedef {('date' | 'information' | 'contact' | 'other')} MetadataQualificationType
+ */
+
+/**
+ * @param {string} metadataName - A metadata name
+ * @returns {MetadataQualificationType | null} The type of the metadata
+ * @description Returns the type of the metatada from a metadata name
+ */
+
+
+exports.formatMetadataQualification = formatMetadataQualification;
+
+var getMetadataQualificationType = function getMetadataQualificationType(metadataName) {
+  if (KNOWN_DATE_METADATA_NAMES.includes(metadataName)) {
+    return 'date';
+  }
+
+  if (KNOWN_INFORMATION_METADATA_NAMES.includes(metadataName)) {
+    return 'information';
+  }
+
+  if (KNOWN_OTHER_METADATA_NAMES.includes(metadataName)) {
+    if (metadataName === 'contact') {
+      return 'contact';
+    }
+
+    return 'other';
+  }
+
+  return null;
+};
+/**
+ * @param {string} name - The name of a metadata of type date like 'expirationDate' or 'shootingDate'
+ * @param {Object} options - Options
+ * @param {string} options.lang - Lang requested for the translation like 'fr' or 'en'
+ * @returns {string} Translated name for the metadata
+ */
+
+
+exports.getMetadataQualificationType = getMetadataQualificationType;
+
+var getTranslatedNameForDateMetadata = function getTranslatedNameForDateMetadata(name, _ref2) {
+  var lang = _ref2.lang;
+  var t = (0, _locales.getLocalizer)(lang);
+  return t("Scan.qualification.date.title.".concat(name));
+};
+/**
+ * @param {string} value - The value of a metadata of type date
+ * @param {Object} options - Options
+ * @param {string} options.lang - Lang requested for the translation
+ * @param {function} options.f - Date formatting function
+ * @returns {string} Formatted and translated value for the metadata
+ */
+
+
+exports.getTranslatedNameForDateMetadata = getTranslatedNameForDateMetadata;
+
+var formatDateMetadataValue = function formatDateMetadataValue(value, _ref3) {
+  var lang = _ref3.lang,
+      f = _ref3.f;
+  var t = (0, _locales.getLocalizer)(lang);
+
+  if (value) {
+    if (lang === 'en') {
+      return f(value, 'MM/DD/YYYY');
+    }
+
+    return f(value, 'DD/MM/YYYY');
+  } else {
+    return t('Scan.qualification.noInfo');
+  }
+};
+/**
+ * @param {string} name - The name of a metadata of type information like 'national_id_card' or 'fine'
+ * @param {Object} options - Options
+ * @param {string} options.lang - Lang requested for the translation
+ * @param {string} options.qualificationLabel - The qualification label of the metadata
+ * @returns {string} Translated name for the metadata
+ */
+
+
+exports.formatDateMetadataValue = formatDateMetadataValue;
+
+var getTranslatedNameForInformationMetadata = function getTranslatedNameForInformationMetadata(name, _ref4) {
+  var lang = _ref4.lang,
+      qualificationLabel = _ref4.qualificationLabel;
+  var t = (0, _locales.getLocalizer)(lang);
+
+  if (name === 'number') {
+    return t("Scan.qualification.information.title.".concat(qualificationLabel, ".").concat(name));
+  } else {
+    return t("Scan.qualification.information.title.".concat(name));
+  }
+};
+/**
+ * @param {string} value - The value of a metadata of type information
+ * @param {Object} options - Options
+ * @param {string} options.lang - Lang requested for the translation
+ * @param {string} options.name - The name of the metadata
+ * @param {string} options.qualificationLabel - The qualification label of the metadata
+ * @returns {string} Formatted and translated value for the metadata
+ */
+
+
+exports.getTranslatedNameForInformationMetadata = getTranslatedNameForInformationMetadata;
+
+var formatInformationMetadataValue = function formatInformationMetadataValue(value, _ref5) {
+  var lang = _ref5.lang,
+      name = _ref5.name,
+      qualificationLabel = _ref5.qualificationLabel;
+  var t = (0, _locales.getLocalizer)(lang);
+
+  if (typeof value !== 'number' && !value) {
+    return t('Scan.qualification.noInfo');
+  }
+
+  if (name === 'noticePeriod') {
+    return "".concat(value, " ").concat(t('Scan.qualification.information.day', {
+      smart_count: value
+    }));
+  }
+
+  if (name === 'contractType') {
+    return t("Scan.attributes.contractType.".concat(value), {
+      _: value
+    });
+  }
+
+  if (name === 'refTaxIncome' || name === 'netSocialAmount' || name === 'number' && qualificationLabel === 'pay_sheet') {
+    return "".concat(value, " \u20AC");
+  }
+
+  return value;
+};
+/**
+ * @param {string} name - The name of a metadata of type other like 'page' or 'qualification'
+ * @param {Object} options - Options
+ * @param {string} options.lang - Lang requested for the translation
+ * @returns {string} Translated name for the metadata
+ */
+
+
+exports.formatInformationMetadataValue = formatInformationMetadataValue;
+
+var getTranslatedNameForOtherMetadata = function getTranslatedNameForOtherMetadata(name, _ref6) {
+  var lang = _ref6.lang;
+  var t = (0, _locales.getLocalizer)(lang);
+  return t("Scan.qualification.".concat(name));
+};
+/**
+ * @param {string} value - The value of a metadata of type other
+ * @param {Object} options - Options
+ * @param {string} options.lang - Lang requested for the translation
+ * @param {string} options.name - The name of the metadata
+ * @returns {string} Formatted and translated value for the metadata
+ */
+
+
+exports.getTranslatedNameForOtherMetadata = getTranslatedNameForOtherMetadata;
+
+var formatOtherMetadataValue = function formatOtherMetadataValue(value, _ref7) {
+  var lang = _ref7.lang,
+      name = _ref7.name;
+  var t = (0, _locales.getLocalizer)(lang);
+
+  if (name === 'qualification') {
+    return t("Scan.items.".concat(value), {
+      smart_count: 1
+    });
+  } else {
+    return t("Scan.qualification.".concat(value));
+  }
+};
+/**
+ * @param {Object} options - Options
+ * @param {string} options.lang - Lang requested for the translation
+ * @returns {string} Translated name for contact
+ */
+
+
+exports.formatOtherMetadataValue = formatOtherMetadataValue;
+
+var getTranslatedNameForContact = function getTranslatedNameForContact(_ref8) {
+  var lang = _ref8.lang;
+  var t = (0, _locales.getLocalizer)(lang);
+  return t('Scan.qualification.contact');
+};
+/**
+ * @param {object[]} contacts - An array of contact
+ * @returns {string} Formatted and translated value of an array of contact
+ */
+
+
+exports.getTranslatedNameForContact = getTranslatedNameForContact;
+
+var formatContactValue = function formatContactValue(contacts) {
+  return contacts && contacts.length > 0 ? contacts.map(function (contact) {
+    return "".concat((0, _contact.getDisplayName)(contact));
+  }).join(', ') : '';
+};
+
+exports.formatContactValue = formatContactValue;

package/dist/models/paper.spec.js

@@ -179,4 +179,73 @@ describe('Expiration', () => {
       }
     )
   })
+
+  describe('formatMetadataQualification', () => {
+    it('should return correctly formatted metadata', () => {
+      const fakeMetadata = {
+        number: '111111',
+        AObtentionDate: '2029-12-01T23:00:00.000Z',
+        BObtentionDate: '2029-12-02T23:00:00.000Z',
+        CObtentionDate: '2029-12-03T23:00:00.000Z',
+        DObtentionDate: '2029-12-04T23:00:00.000Z',
+        expirationDate: '2029-12-05T23:00:00.000Z',
+        referencedDate: '2029-12-06T23:00:00.000Z',
+        issueDate: '2029-12-07T23:00:00.000Z',
+        shootingDate: '2029-12-08T23:00:00.000Z',
+        date: '2029-12-09T23:00:00.000Z',
+        datetime: '2029-12-10T23:00:00.000Z',
+        qualification: { label: 'fake_label' },
+        page: 'front',
+        contact: 'Alice Durand'
+      }
+
+      const computedMetadata = [
+        { name: 'AObtentionDate', value: '2029-12-01T23:00:00.000Z' },
+        { name: 'BObtentionDate', value: '2029-12-02T23:00:00.000Z' },
+        { name: 'CObtentionDate', value: '2029-12-03T23:00:00.000Z' },
+        { name: 'DObtentionDate', value: '2029-12-04T23:00:00.000Z' },
+        { name: 'expirationDate', value: '2029-12-05T23:00:00.000Z' },
+        { name: 'referencedDate', value: '2029-12-06T23:00:00.000Z' },
+        { name: 'issueDate', value: '2029-12-07T23:00:00.000Z' },
+        { name: 'shootingDate', value: '2029-12-08T23:00:00.000Z' },
+        { name: 'date', value: '2029-12-09T23:00:00.000Z' },
+        { name: 'number', value: '111111' },
+        { name: 'contact', value: 'Alice Durand' },
+        { name: 'page', value: 'front' },
+        { name: 'qualification', value: 'fake_label' }
+      ]
+
+      const res = paperModel.formatMetadataQualification(fakeMetadata)
+      expect(res).toEqual(computedMetadata)
+    })
+  })
+
+  describe('formatInformationMetadataValue', () => {
+    it('should return value with suffix locale', () => {
+      const res = paperModel.formatInformationMetadataValue('88', {
+        name: 'noticePeriod',
+        lang: 'en'
+      })
+
+      expect(res).toEqual('88 days')
+    })
+
+    it('should return "noInfo" value', () => {
+      const res = paperModel.formatInformationMetadataValue('', {
+        name: 'metadataName',
+        lang: 'en'
+      })
+
+      expect(res).toEqual('No information')
+    })
+
+    it('should return value if not in other case', () => {
+      const res = paperModel.formatInformationMetadataValue('metadataValue', {
+        name: 'metadataName',
+        lang: 'en'
+      })
+
+      expect(res).toEqual('metadataValue')
+    })
+  })
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "45.14.0",
+  "version": "45.15.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -75,5 +75,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "9a59a373f50cefebe66c7dadb2b229dcc3308a77"
+  "gitHead": "3eb9be9c7a7efaade9593fe809ff24f02780a5b1"
 }

package/types/Provider.d.ts

@@ -6,7 +6,7 @@ export default class CozyProvider extends React.Component<any, any, any> {
             getState: PropTypes.Validator<(...args: any[]) => any>;
         }>>;
         client: PropTypes.Validator<object>;
-        children: PropTypes.Validator<PropTypes.ReactElementLike>;
+        children: PropTypes.Validator<PropTypes.ReactElementLike | PropTypes.ReactElementLike[]>;
     };
     static childContextTypes: {
         store: PropTypes.Requireable<object>;

package/types/models/paper.d.ts

@@ -1,7 +1,43 @@
+export const KNOWN_DATE_METADATA_NAMES: string[];
+export const KNOWN_INFORMATION_METADATA_NAMES: string[];
+export const KNOWN_OTHER_METADATA_NAMES: string[];
 export function isExpiring(file: IOCozyFile): boolean;
 export function computeExpirationDate(file: IOCozyFile): Date | null;
 export function computeExpirationNoticeDate(file: IOCozyFile): Date | null;
 export function computeExpirationNoticeLink(file: IOCozyFile): string | null;
 export function isExpired(file: IOCozyFile): boolean;
 export function isExpiringSoon(file: IOCozyFile): boolean;
+export function formatMetadataQualification(metadata: any): {
+    name: string;
+    value: string | null;
+}[];
+export function getMetadataQualificationType(metadataName: string): MetadataQualificationType | null;
+export function getTranslatedNameForDateMetadata(name: string, { lang }: {
+    lang: string;
+}): string;
+export function formatDateMetadataValue(value: string, { lang, f }: {
+    lang: string;
+    f: Function;
+}): string;
+export function getTranslatedNameForInformationMetadata(name: string, { lang, qualificationLabel }: {
+    lang: string;
+    qualificationLabel: string;
+}): string;
+export function formatInformationMetadataValue(value: string, { lang, name, qualificationLabel }: {
+    lang: string;
+    name: string;
+    qualificationLabel: string;
+}): string;
+export function getTranslatedNameForOtherMetadata(name: string, { lang }: {
+    lang: string;
+}): string;
+export function formatOtherMetadataValue(value: string, { lang, name }: {
+    lang: string;
+    name: string;
+}): string;
+export function getTranslatedNameForContact({ lang }: {
+    lang: string;
+}): string;
+export function formatContactValue(contacts: object[]): string;
 export type IOCozyFile = import("../types").CozyClientDocument & import("../types").FileDocument;
+export type MetadataQualificationType = "other" | "date" | "contact" | "information";