cozy-client 46.4.0 → 46.5.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 = "46.4.0";
+CozyClient.version = "46.5.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/types.js

@@ -431,6 +431,103 @@ var _dsl = require("./queries/dsl");
  * @typedef {CozyClientDocument & OAuthClientDocument} IOCozyOAuthClient - An io.cozy.oauth.clients document
  */
 
+/**
+ * @typedef {object} ContactName
+ * @property {string} [familyName] - The family name (example: "House")
+ * @property {string} [givenName] - The given name (example: "Gregory")
+ * @property {string} [additionalName] - The additional name (example: "J.")
+ * @property {string} [namePrefix] - The name prefix (example: "Dr.")
+ * @property {string} [nameSuffix] - The name suffix (example: "III")
+ */
+
+/**
+ * @typedef {object} ContactEmail
+ * @property {string} address - Email address
+ * @property {string} [type] - A user-provided localized type of email address (example: "Work", "Home", "Other")
+ * @property {boolean} [primary] - Indicates a preferred-use address
+ */
+
+/**
+ * @typedef {object} ContactExtendedAddress
+ * @property {string} [locality] - Locality name
+ * @property {string} [building] - Building number
+ * @property {string} [stairs] - Stairs number
+ * @property {string} [floor] - Apartment floor
+ * @property {string} [apartment] - Apartment number
+ * @property {string} [entrycode] - Entry code
+ */
+
+/**
+ * @typedef {object} ContactGeo
+ * @property {Array<number>} [geo] - Coordinates of the address, must be [long, lat]
+ * @property {"home"|"work"} [cozyCategory] - The category of the address type
+ */
+
+/**
+ * @typedef {object} ContactAddress
+ * @property {string} [id] - Id of the address
+ * @property {string} [street] - Street name
+ * @property {string} [pobox] - P.O Box number
+ * @property {string} [city] - City name
+ * @property {string} [region] - Region name
+ * @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 {boolean} [primary] - Indicates a preferred-use address
+ * @property {ContactExtendedAddress} [extendedAddress]
+ * @property {string} [formattedAddress] - Unstructured version of the address
+ * @property {ContactGeo} [geo]
+ */
+
+/**
+ * @typedef {object} ContactPhone
+ * @property {string} number - Phone number
+ * @property {string} [type] - A user-provided localized type of phone number (example: "Work", "Home", "Other")
+ * @property {boolean} [primary] - Indicates a preferred-use number
+ *
+ */
+
+/**
+ * @typedef {object} ContactCozy
+ * @property {string} url
+ * @property {string} [label] - A user-provided localized type of instance
+ * @property {boolean} [primary] - Indicates a preferred-use instance
+ *
+ */
+
+/**
+ * @typedef {object} ContactMetadata
+ * @property {boolean} cozy - Whether the contact has been created by cozy
+ * @property {object} google - Google metadata
+ * @property {number} version - Used for migrations. Current version is 1
+ *
+ */
+
+/**
+ * @typedef {object} ContactDocument
+ * @property {object} indexes - Used to sort contacts in different ways
+ * @property {string} indexes.byFamilyNameGivenNameEmailCozyUrl - Index for sorting
+ * @property {string} displayName - Displayed name in cozy applications
+ * @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 {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} 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)
+ * @property {boolean} me - Whether the contact matches the cozy owner (defaults to false)
+ * @property {Array<string>} [nationalities] - 2-letter iso3166 country codes (can be set in io.cozy.identities for legal reasons in Banks)
+ * @property {string} [birthcity] - City of birth of a contact (can be set in io.cozy.identities for legal reasons in Banks)
+ * @property {string} [birthcountry] - Country of birth of a contact (can be set in io.cozy.identities for legal reasons in Banks)
+ * @property {ContactMetadata} metadata - Previous metadata information
+ * @typedef {CozyClientDocument & ContactDocument} IOCozyContact - An io.cozy.contacts document
+ */
+
 /**
  * @typedef {object} ClientError
  * @property {string} [status]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "46.4.0",
+  "version": "46.5.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -18,7 +18,7 @@
     "@types/jest": "^26.0.20",
     "@types/lodash": "^4.14.170",
     "btoa": "^1.2.1",
-    "cozy-stack-client": "^46.1.0",
+    "cozy-stack-client": "^46.5.0",
     "date-fns": "2.29.3",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.13",
@@ -75,5 +75,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "7425c7d2dee49b2c2c54b95695754219bbe5bc0b"
+  "gitHead": "d6a21c0a61f2f2f37133b12c0c82593779d2f90b"
 }

package/types/types.d.ts

@@ -801,6 +801,245 @@ export type OAuthClientDocument = {
  * - An io.cozy.oauth.clients document
  */
 export type IOCozyOAuthClient = CozyClientDocument & OAuthClientDocument;
+export type ContactName = {
+    /**
+     * - The family name (example: "House")
+     */
+    familyName?: string;
+    /**
+     * - The given name (example: "Gregory")
+     */
+    givenName?: string;
+    /**
+     * - The additional name (example: "J.")
+     */
+    additionalName?: string;
+    /**
+     * - The name prefix (example: "Dr.")
+     */
+    namePrefix?: string;
+    /**
+     * - The name suffix (example: "III")
+     */
+    nameSuffix?: string;
+};
+export type ContactEmail = {
+    /**
+     * - Email address
+     */
+    address: string;
+    /**
+     * - A user-provided localized type of email address (example: "Work", "Home", "Other")
+     */
+    type?: string;
+    /**
+     * - Indicates a preferred-use address
+     */
+    primary?: boolean;
+};
+export type ContactExtendedAddress = {
+    /**
+     * - Locality name
+     */
+    locality?: string;
+    /**
+     * - Building number
+     */
+    building?: string;
+    /**
+     * - Stairs number
+     */
+    stairs?: string;
+    /**
+     * - Apartment floor
+     */
+    floor?: string;
+    /**
+     * - Apartment number
+     */
+    apartment?: string;
+    /**
+     * - Entry code
+     */
+    entrycode?: string;
+};
+export type ContactGeo = {
+    /**
+     * - Coordinates of the address, must be [long, lat]
+     */
+    geo?: Array<number>;
+    /**
+     * - The category of the address type
+     */
+    cozyCategory?: "home" | "work";
+};
+export type ContactAddress = {
+    /**
+     * - Id of the address
+     */
+    id?: string;
+    /**
+     * - Street name
+     */
+    street?: string;
+    /**
+     * - P.O Box number
+     */
+    pobox?: string;
+    /**
+     * - City name
+     */
+    city?: string;
+    /**
+     * - Region name
+     */
+    region?: string;
+    /**
+     * - Lane number
+     */
+    number?: string;
+    /**
+     * - Postal code
+     */
+    code?: string;
+    /**
+     * - Country name
+     */
+    country?: string;
+    /**
+     * - A user-provided localized type of address (example: "Work", "Home", "Other")
+     */
+    type?: string;
+    /**
+     * - Indicates a preferred-use address
+     */
+    primary?: boolean;
+    extendedAddress?: ContactExtendedAddress;
+    /**
+     * - Unstructured version of the address
+     */
+    formattedAddress?: string;
+    geo?: ContactGeo;
+};
+export type ContactPhone = {
+    /**
+     * - Phone number
+     */
+    number: string;
+    /**
+     * - A user-provided localized type of phone number (example: "Work", "Home", "Other")
+     */
+    type?: string;
+    /**
+     * - Indicates a preferred-use number
+     */
+    primary?: boolean;
+};
+export type ContactCozy = {
+    url: string;
+    /**
+     * - A user-provided localized type of instance
+     */
+    label?: string;
+    /**
+     * - Indicates a preferred-use instance
+     */
+    primary?: boolean;
+};
+export type ContactMetadata = {
+    /**
+     * - Whether the contact has been created by cozy
+     */
+    cozy: boolean;
+    /**
+     * - Google metadata
+     */
+    google: object;
+    /**
+     * - Used for migrations. Current version is 1
+     */
+    version: number;
+};
+export type ContactDocument = {
+    /**
+     * - Used to sort contacts in different ways
+     */
+    indexes: {
+        byFamilyNameGivenNameEmailCozyUrl: string;
+    };
+    /**
+     * - Displayed name in cozy applications
+     */
+    displayName: string;
+    /**
+     * - Unstructured representation of the name (example: "Dr. Gregory House, M.D.")
+     */
+    fullname?: string;
+    /**
+     * - Structured representation of the name
+     */
+    name?: ContactName;
+    /**
+     * - Birthday (example: "1959-05-15")
+     */
+    birthday?: string;
+    /**
+     * - Note
+     */
+    note?: string;
+    /**
+     * - Email addresses
+     */
+    email?: Array<ContactEmail>;
+    /**
+     * - Addresses
+     */
+    address?: Array<ContactAddress>;
+    /**
+     * - Phone numbers
+     */
+    phone?: Array<ContactPhone>;
+    /**
+     * - Cozy instances
+     */
+    cozy?: Array<ContactCozy>;
+    /**
+     * - Company
+     */
+    company: string;
+    /**
+     * - Job title
+     */
+    jobTitle: string;
+    /**
+     * - true if the contact is marked for removal and will be deleted soon (e.g. after remote deletion is confirmed)
+     */
+    trashed?: boolean;
+    /**
+     * - Whether the contact matches the cozy owner (defaults to false)
+     */
+    me: boolean;
+    /**
+     * - 2-letter iso3166 country codes (can be set in io.cozy.identities for legal reasons in Banks)
+     */
+    nationalities?: Array<string>;
+    /**
+     * - City of birth of a contact (can be set in io.cozy.identities for legal reasons in Banks)
+     */
+    birthcity?: string;
+    /**
+     * - Country of birth of a contact (can be set in io.cozy.identities for legal reasons in Banks)
+     */
+    birthcountry?: string;
+    /**
+     * - Previous metadata information
+     */
+    metadata: ContactMetadata;
+};
+/**
+ * - An io.cozy.contacts document
+ */
+export type IOCozyContact = CozyClientDocument & ContactDocument;
 export type ClientError = {
     status?: string;
 };