cozy-client 46.9.1 → 46.10.0

package/dist/CozyClient.js

@@ -2782,7 +2782,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 = "46.9.1";
+CozyClient.version = "46.10.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/models/contact.js

@@ -63,7 +63,7 @@ var getInitials = function getInitials(contact) {
 /**
  * Returns the contact's main email
  *
- * @param {object} contact - A contact
+ * @param {import('../types').IOCozyContact} contact - A contact
  * @returns {string} - The contact's main email
  */
 
@@ -76,7 +76,7 @@ var getPrimaryEmail = function getPrimaryEmail(contact) {
 /**
  * Returns the contact's main cozy
  *
- * @param {object} contact - A contact
+ * @param {import('../types').IOCozyContact} contact - A contact
  * @returns {string} - The contact's main cozy
  */
 
@@ -89,7 +89,7 @@ var getPrimaryCozy = function getPrimaryCozy(contact) {
 /**
  * Returns the contact's main cozy url without protocol
  *
- * @param {object} contact - A contact
+ * @param {import('../types').IOCozyContact} contact - A contact
  * @returns {string} - The contact's main cozy url
  */
 
@@ -107,7 +107,7 @@ var getPrimaryCozyDomain = function getPrimaryCozyDomain(contact) {
 /**
  * Returns the contact's main phone number
  *
- * @param {object} contact - A contact
+ * @param {import('../types').IOCozyContact} contact - A contact
  * @returns {string} - The contact's main phone number
  */
 
@@ -120,7 +120,7 @@ var getPrimaryPhone = function getPrimaryPhone(contact) {
 /**
  * Returns the contact's main address
  *
- * @param {object} contact - A contact
+ * @param {import('../types').IOCozyContact} contact - A contact
  * @returns {string} - The contact's main address
  */
 
@@ -140,7 +140,7 @@ var defaultFullnameAttributes = ['namePrefix', 'givenName', 'additionalName', 'f
 /**
  * Makes fullname from contact name
  *
- * @param {object} contact - A contact
+ * @param {import('../types').IOCozyContact} contact - A contact
  * @param {{ attributesFullname: FullnameAttributes[] }} [opts] - Options
  * @returns {string} - The contact's fullname
  */
@@ -161,7 +161,7 @@ var makeFullname = function makeFullname(contact, opts) {
 /**
  * Returns the contact's fullname
  *
- * @param {object} contact - A contact
+ * @param {import('../types').IOCozyContact} contact - A contact
  * @returns {string} - The contact's fullname
  */
 
@@ -178,7 +178,7 @@ var getFullname = function getFullname(contact) {
 /**
  * Makes displayName from contact data
  *
- * @param {*} contact - A contact
+ * @param {import('../types').IOCozyContact} contact - A contact
  * @param {{ attributesFullname: FullnameAttributes[] }} [opts] - Options
  * @returns {string} - The contact's displayName
  */
@@ -208,7 +208,7 @@ var makeDisplayName = function makeDisplayName(contact, opts) {
 /**
  * Returns a display name for the contact
  *
- * @param {object} contact - A contact
+ * @param {import('../types').IOCozyContact} contact - A contact
  * @returns {string} - the contact's display name
  **/
 
@@ -225,7 +225,7 @@ var getDisplayName = function getDisplayName(contact) {
 /**
  * Makes 'byFamilyNameGivenNameEmailCozyUrl' index of a contact
  *
- * @param {object} contact - A contact
+ * @param {import('../types').IOCozyContact} contact - A contact
  * @returns {string} - the contact's 'byFamilyNameGivenNameEmailCozyUrl' index
  */
 
@@ -244,7 +244,7 @@ var makeDefaultSortIndexValue = function makeDefaultSortIndexValue(contact) {
 /**
  * Returns 'byFamilyNameGivenNameEmailCozyUrl' index of a contact
  *
- * @param {object} contact - A contact
+ * @param {import('../types').IOCozyContact} contact - A contact
  * @returns {string} - the contact's 'byFamilyNameGivenNameEmailCozyUrl' index
  */
 
@@ -264,7 +264,7 @@ var getDefaultSortIndexValue = function getDefaultSortIndexValue(contact) {
  * Returns 'byFamilyNameGivenNameEmailCozyUrl' index of a contact
  *
  * @deprecated Prefer to use getDefaultSortIndexValue.
- * @param {object} contact - A contact
+ * @param {import('../types').IOCozyContact} contact - A contact
  * @returns {string} - the contact's 'byFamilyNameGivenNameEmailCozyUrl' index
  */
 

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

@@ -157,6 +157,11 @@
       "undefined": "Undefined",
       "work_study": "Work & Study"
     },
+    "expiration": {
+      "expired": "Expired",
+      "expiresIn": "Expires in %{duration}",
+      "description": "This document expires in %{duration}, consider renewing it"
+    },
     "qualification": {
       "date": {
         "title": {

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

@@ -157,6 +157,11 @@
       "undefined": "Indéfini",
       "work_study": "Travail & Études"
     },
+    "expiration": {
+      "expired": "Expiré",
+      "expiresIn": "Expire dans %{duration}",
+      "description": "Ce document expire dans %{duration}, pensez à le renouveler"
+    },
     "qualification": {
       "date": {
         "title": {

package/dist/models/paper.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-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;
+exports.makeExpirationDescription = exports.makeExpiresInMessage = exports.makeExpiredMessage = 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"));
 
@@ -13,6 +13,10 @@ var _add = _interopRequireDefault(require("date-fns/add"));
 
 var _sub = _interopRequireDefault(require("date-fns/sub"));
 
+var _formatDistanceToNowStrict = _interopRequireDefault(require("date-fns/formatDistanceToNowStrict"));
+
+var _fr = _interopRequireDefault(require("date-fns/locale/fr"));
+
 var _locales = require("./document/locales");
 
 var _contact = require("./contact");
@@ -508,5 +512,61 @@ var formatContactValue = function formatContactValue(contacts) {
     return "".concat((0, _contact.getDisplayName)(contact));
   }).join(', ') : '';
 };
+/**
+ * @param {Object} options - Options
+ * @param {string} options.lang - Lang requested for the translation
+ * @returns {string}
+ */
+
+
+exports.formatContactValue = formatContactValue;
+
+var makeExpiredMessage = function makeExpiredMessage(_ref9) {
+  var lang = _ref9.lang;
+  var t = (0, _locales.getLocalizer)(lang);
+  return t('Scan.expiration.expired');
+};
+/**
+ * @param {string} expirationDate - Expiration date
+ * @param {Object} options - Options
+ * @param {string} options.lang - Lang requested for the translation
+ * @returns {string}
+ */
+
+
+exports.makeExpiredMessage = makeExpiredMessage;
+
+var makeExpiresInMessage = function makeExpiresInMessage(expirationDate, _ref10) {
+  var lang = _ref10.lang;
+  var t = (0, _locales.getLocalizer)(lang);
+  var distance = (0, _formatDistanceToNowStrict.default)(new Date(expirationDate), {
+    locale: lang === 'fr' ? _fr.default : undefined // fallbacks to english if undefined
+
+  });
+  return t('Scan.expiration.expiresIn', {
+    duration: distance
+  });
+};
+/**
+ * @param {string} expirationDate - Expiration date
+ * @param {Object} options - Options
+ * @param {string} options.lang - Lang requested for the translation
+ * @returns {string}
+ */
+
+
+exports.makeExpiresInMessage = makeExpiresInMessage;
+
+var makeExpirationDescription = function makeExpirationDescription(expirationDate, _ref11) {
+  var lang = _ref11.lang;
+  var t = (0, _locales.getLocalizer)(lang);
+  var distance = (0, _formatDistanceToNowStrict.default)(new Date(expirationDate), {
+    locale: lang === 'fr' ? _fr.default : undefined // fallbacks to english if undefined
+
+  });
+  return t('Scan.expiration.description', {
+    duration: distance
+  });
+};
 
-exports.formatContactValue = formatContactValue;
+exports.makeExpirationDescription = makeExpirationDescription;

package/dist/types.js

@@ -483,7 +483,8 @@ var _dsl = require("./queries/dsl");
 /**
  * @typedef {object} ContactEmail
  * @property {string} address - Email address
- * @property {string} [type] - A user-provided localized type of email address (example: "Work", "Home", "Other")
+ * @property {string} [type] - A user-provided localized type (example: `"Personal"`, `"Professional"`, `"Other"`)
+ * @property {'work'|'home'} [label] - A keyword to identify the type, must be `work|home`
  * @property {boolean} [primary] - Indicates a preferred-use address
  */
 
@@ -513,7 +514,8 @@ var _dsl = require("./queries/dsl");
  * @property {string} [number] - Lane number
  * @property {string} [code] - Postal code
  * @property {string} [country] - Country name
- * @property {string} [type] - A user-provided localized type of address (example: "Work", "Home", "Other")
+ * @property {string} [type] - A user-provided localized type (example: `"Personal"`, `"Professional"`, `"Other"`)
+ * @property {'work'|'home'} [label] - A keyword to identify the type, must be `work|home`
  * @property {boolean} [primary] - Indicates a preferred-use address
  * @property {ContactExtendedAddress} [extendedAddress]
  * @property {string} [formattedAddress] - Unstructured version of the address
@@ -523,7 +525,8 @@ var _dsl = require("./queries/dsl");
 /**
  * @typedef {object} ContactPhone
  * @property {string} number - Phone number
- * @property {string} [type] - A user-provided localized type of phone number (example: "Work", "Home", "Other")
+ * @property {string} [type] - A user-provided localized type (example: `"Personal"`, `"Professional"`, `"Other"`), could be provided by Contacts app too as `voice|fax|cell`
+ * @property {'work'|'home'} [label] - A keyword to identify the type, must be `work|home`
  * @property {boolean} [primary] - Indicates a preferred-use number
  *
  */
@@ -531,7 +534,8 @@ var _dsl = require("./queries/dsl");
 /**
  * @typedef {object} ContactCozy
  * @property {string} url
- * @property {string} [label] - A user-provided localized type of instance
+ * @property {string} [type] - A user-provided localized type (example: `"Personal"`, `"Professional"`, `"Other"`)
+ * @property {'work'|'home'} [label] - A keyword to identify the type, must be `work|home`
  * @property {boolean} [primary] - Indicates a preferred-use instance
  *
  */
@@ -552,11 +556,13 @@ var _dsl = require("./queries/dsl");
  * @property {string} [fullname] - Unstructured representation of the name (example: "Dr. Gregory House, M.D.")
  * @property {ContactName} [name] - Structured representation of the name
  * @property {string} [birthday] - Birthday (example: "1959-05-15")
+ * @property {'male'|'female'} [gender] - Gender (example: "female")
  * @property {string} [note] - Note
  * @property {Array<ContactEmail>} [email] - Email addresses
  * @property {Array<ContactAddress>} [address] - Addresses
  * @property {Array<ContactPhone>} [phone] - Phone numbers
  * @property {Array<ContactCozy>} [cozy] - Cozy instances
+ * @property {string} [url] - Cozy instance url (deprecated)
  * @property {string} company - Company
  * @property {string} jobTitle - Job title
  * @property {boolean} [trashed] - true if the contact is marked for removal and will be deleted soon (e.g. after remote deletion is confirmed)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "46.9.1",
+  "version": "46.10.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": "24ff9fa1c4abd0573c1f49fce91155732e657d46"
+  "gitHead": "97faf6da325ae1051675f67dd455090cdc88f17c"
 }

package/types/models/contact.d.ts

@@ -1,21 +1,21 @@
 export const CONTACTS_DOCTYPE: "io.cozy.contacts";
 export function getPrimaryOrFirst(property: any): (obj: any) => any;
 export function getInitials(contact: import('../types').IOCozyContact): string;
-export function getPrimaryEmail(contact: object): string;
-export function getPrimaryCozy(contact: object): string;
-export function getPrimaryCozyDomain(contact: object): string;
-export function getPrimaryPhone(contact: object): string;
-export function getPrimaryAddress(contact: object): string;
-export function makeFullname(contact: object, opts?: {
+export function getPrimaryEmail(contact: import('../types').IOCozyContact): string;
+export function getPrimaryCozy(contact: import('../types').IOCozyContact): string;
+export function getPrimaryCozyDomain(contact: import('../types').IOCozyContact): string;
+export function getPrimaryPhone(contact: import('../types').IOCozyContact): string;
+export function getPrimaryAddress(contact: import('../types').IOCozyContact): string;
+export function makeFullname(contact: import('../types').IOCozyContact, opts?: {
     attributesFullname: FullnameAttributes[];
 }): string;
-export function getFullname(contact: object): string;
-export function makeDisplayName(contact: any, opts?: {
+export function getFullname(contact: import('../types').IOCozyContact): string;
+export function makeDisplayName(contact: import('../types').IOCozyContact, opts?: {
     attributesFullname: FullnameAttributes[];
 }): string;
-export function getDisplayName(contact: object): string;
-export function makeDefaultSortIndexValue(contact: object): string;
-export function getDefaultSortIndexValue(contact: object): string;
-export function getIndexByFamilyNameGivenNameEmailCozyUrl(contact: object): string;
+export function getDisplayName(contact: import('../types').IOCozyContact): string;
+export function makeDefaultSortIndexValue(contact: import('../types').IOCozyContact): string;
+export function getDefaultSortIndexValue(contact: import('../types').IOCozyContact): string;
+export function getIndexByFamilyNameGivenNameEmailCozyUrl(contact: import('../types').IOCozyContact): string;
 export function isContact(doc: object): boolean;
 export type FullnameAttributes = "namePrefix" | "givenName" | "additionalName" | "familyName" | "nameSuffix";

package/types/models/paper.d.ts

@@ -39,5 +39,14 @@ export function getTranslatedNameForContact({ lang }: {
     lang: string;
 }): string;
 export function formatContactValue(contacts: object[]): string;
+export function makeExpiredMessage({ lang }: {
+    lang: string;
+}): string;
+export function makeExpiresInMessage(expirationDate: string, { lang }: {
+    lang: string;
+}): string;
+export function makeExpirationDescription(expirationDate: string, { lang }: {
+    lang: string;
+}): string;
 export type IOCozyFile = import("../types").CozyClientDocument & import("../types").FileDocument;
 export type MetadataQualificationType = "other" | "date" | "contact" | "information";

package/types/types.d.ts

@@ -861,9 +861,13 @@ export type ContactEmail = {
      */
     address: string;
     /**
-     * - A user-provided localized type of email address (example: "Work", "Home", "Other")
+     * - A user-provided localized type (example: `"Personal"`, `"Professional"`, `"Other"`)
      */
     type?: string;
+    /**
+     * - A keyword to identify the type, must be `work|home`
+     */
+    label?: 'work' | 'home';
     /**
      * - Indicates a preferred-use address
      */
@@ -939,9 +943,13 @@ export type ContactAddress = {
      */
     country?: string;
     /**
-     * - A user-provided localized type of address (example: "Work", "Home", "Other")
+     * - A user-provided localized type (example: `"Personal"`, `"Professional"`, `"Other"`)
      */
     type?: string;
+    /**
+     * - A keyword to identify the type, must be `work|home`
+     */
+    label?: 'work' | 'home';
     /**
      * - Indicates a preferred-use address
      */
@@ -959,9 +967,13 @@ export type ContactPhone = {
      */
     number: string;
     /**
-     * - A user-provided localized type of phone number (example: "Work", "Home", "Other")
+     * - A user-provided localized type (example: `"Personal"`, `"Professional"`, `"Other"`), could be provided by Contacts app too as `voice|fax|cell`
      */
     type?: string;
+    /**
+     * - A keyword to identify the type, must be `work|home`
+     */
+    label?: 'work' | 'home';
     /**
      * - Indicates a preferred-use number
      */
@@ -970,9 +982,13 @@ export type ContactPhone = {
 export type ContactCozy = {
     url: string;
     /**
-     * - A user-provided localized type of instance
+     * - A user-provided localized type (example: `"Personal"`, `"Professional"`, `"Other"`)
      */
-    label?: string;
+    type?: string;
+    /**
+     * - A keyword to identify the type, must be `work|home`
+     */
+    label?: 'work' | 'home';
     /**
      * - Indicates a preferred-use instance
      */
@@ -1015,6 +1031,10 @@ export type ContactDocument = {
      * - Birthday (example: "1959-05-15")
      */
     birthday?: string;
+    /**
+     * - Gender (example: "female")
+     */
+    gender?: 'male' | 'female';
     /**
      * - Note
      */
@@ -1035,6 +1055,10 @@ export type ContactDocument = {
      * - Cozy instances
      */
     cozy?: Array<ContactCozy>;
+    /**
+     * - Cozy instance url (deprecated)
+     */
+    url?: string;
     /**
      * - Company
      */