cozy-client 48.6.0 → 48.8.0

package/dist/CozyClient.js

@@ -2830,7 +2830,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 = "48.6.0";
+CozyClient.version = "48.8.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/models/paper.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-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_BILLS_ATTRIBUTES_NAMES = exports.KNOWN_OTHER_METADATA_NAMES = exports.KNOWN_INFORMATION_METADATA_NAMES = exports.KNOWN_DATE_METADATA_NAMES = void 0;
+exports.isForeignPaper = 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_BILLS_ATTRIBUTES_NAMES = 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"));
 
@@ -585,5 +585,22 @@ var makeExpirationDescription = function makeExpirationDescription(expirationDat
     duration: distance
   });
 };
+/**
+ * @param {IOCozyFile} file - io.cozy.files document
+ * @returns {boolean}
+ */
+
+
+exports.makeExpirationDescription = makeExpirationDescription;
+
+var isForeignPaper = function isForeignPaper(file) {
+  var _file$metadata13;
+
+  if ((_file$metadata13 = file.metadata) !== null && _file$metadata13 !== void 0 && _file$metadata13.country) {
+    return file.metadata.country.toLowerCase() !== 'fr';
+  }
+
+  return false;
+};
 
-exports.makeExpirationDescription = makeExpirationDescription;
+exports.isForeignPaper = isForeignPaper;

package/dist/models/paper.spec.js

@@ -9,17 +9,20 @@ import * as paperModel from './paper'
  * @param {string} [param.expirationDate] - expiration date of file
  * @param {string} [param.referencedDate] - reference date of file
  * @param {string} [param.noticePeriod] - period before send notification
+ * @param {object} [param.metadata] - metadata of file
  */
 const buildMockFile = ({
   qualificationLabel,
   expirationDate,
   referencedDate,
-  noticePeriod
+  noticePeriod,
+  metadata = {}
 }) => {
   return /** @type {import('../types').IOCozyFile} */ ({
     name: qualificationLabel,
     created_at: '2022-09-01T00:00:00.000Z',
     metadata: {
+      ...metadata,
       qualification: { label: qualificationLabel },
       ...(expirationDate && { expirationDate }),
       ...(referencedDate && { referencedDate }),
@@ -43,7 +46,18 @@ describe('Expiration', () => {
   const fakeNationalIdCardFile = buildMockFile({
     qualificationLabel: 'national_id_card',
     expirationDate: '2022-09-23T11:35:58.118Z',
-    noticePeriod: '90'
+    noticePeriod: '90',
+    metadata: {
+      country: 'FR'
+    }
+  })
+  const fakeForeignNationalIdCardFile = buildMockFile({
+    qualificationLabel: 'national_id_card',
+    expirationDate: '2022-09-23T11:35:58.118Z',
+    noticePeriod: '90',
+    metadata: {
+      country: 'BE'
+    }
   })
   const fakePassportFile = buildMockFile({
     qualificationLabel: 'passport',
@@ -263,4 +277,18 @@ describe('Expiration', () => {
       expect(res).toEqual('France')
     })
   })
+
+  describe('isForeignPaper', () => {
+    it('should return true if the paper is a foreign paper', () => {
+      const res = paperModel.isForeignPaper(fakeForeignNationalIdCardFile)
+
+      expect(res).toBe(true)
+    })
+
+    it('should return false if the paper is not a foreign paper', () => {
+      const res = paperModel.isForeignPaper(fakeNationalIdCardFile)
+
+      expect(res).toBe(false)
+    })
+  })
 })

package/dist/types.js

@@ -393,6 +393,27 @@ var _dsl = require("./queries/dsl");
  * @property {Function} [updateQueries]
  */
 
+/**
+ * @typedef {object} UpdatedByApp
+ * @property {string} slug - Slug of the app that updated the document
+ * @property {string} date - Date of the update
+ * @property {number} version - Version of the app that updated the document
+ */
+
+/**
+ * @typedef {object} CozyMetadata
+ * @property {number} [doctypeVersion] - Version of the doctype
+ * @property {number} [metadataVersion] - Version of the metadata
+ * @property {string} [createdAt] - Date of creation
+ * @property {string} [createdByApp] - Slug of the app that created the document
+ * @property {string} [createdByAppVersion] - Version of the app that created the document
+ * @property {string} [updatedAt] - Date of the last update
+ * @property {UpdatedByApp[]} [updatedByApps] - List of apps that updated the document
+ * @property {string} [sourceAccount] - Id of the account associated to the document
+ * @property {string} [sourceAccountIdentifier] - Identifier of the source account
+ * @property {boolean} [favorite] - Whether the document is marked as favorite
+ */
+
 /**
  * @typedef {object} CozyClientDocument - A document
  * @property {string} [_id] - Id of the document
@@ -402,7 +423,7 @@ var _dsl = require("./queries/dsl");
  * @property {boolean} [_deleted] - When the document has been deleted
  * @property {ReferencedByRelationship} [relationships] - Relationships of the document
  * @property {Reference[]} [referenced_by] - referenced by of another document
- * @property {object} [cozyMetadata] - Cozy Metadata
+ * @property {CozyMetadata} [cozyMetadata] - Cozy Metadata
  */
 
 /**
@@ -425,12 +446,15 @@ var _dsl = require("./queries/dsl");
  * @property {string} [referencedDate] - Reference date of the paper
  * @property {string} [noticePeriod] - Notice period of the paper, in days
  * @property {string} [datetime] - Image EXIF date, if relevant
+ * @property {string} [instanceName] - Name of the instance
  */
 
 /**
  * @typedef {object} FileDocument - An io.cozy.files document
  * @property {string} _id - Id of the file
  * @property {FilesDoctype} _type - Doctype of the file
+ * @property {string} dir_id - Id of the parent folder
+ * @property {string} [path] - Path of the file
  * @property {string} name - Name of the file
  * @property {FileMetadata} metadata - Metadata of the file
  * @property {string} type - Type of the file

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "48.6.0",
+  "version": "48.8.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": "efc8ef2847f0a105542e440168e0071565fcc716"
+  "gitHead": "436e11e6ff7d688533c20a53c01fd546dc1a03ea"
 }

package/types/models/paper.d.ts

@@ -49,5 +49,6 @@ export function makeExpiresInMessage(expirationDate: string, { lang }: {
 export function makeExpirationDescription(expirationDate: string, { lang }: {
     lang: string;
 }): string;
+export function isForeignPaper(file: IOCozyFile): boolean;
 export type IOCozyFile = import("../types").CozyClientDocument & import("../types").FileDocument;
 export type MetadataQualificationType = "other" | "date" | "contact" | "information" | "bills";

package/types/types.d.ts

@@ -638,6 +638,62 @@ export type MutationOptions = {
     update?: Function;
     updateQueries?: Function;
 };
+export type UpdatedByApp = {
+    /**
+     * - Slug of the app that updated the document
+     */
+    slug: string;
+    /**
+     * - Date of the update
+     */
+    date: string;
+    /**
+     * - Version of the app that updated the document
+     */
+    version: number;
+};
+export type CozyMetadata = {
+    /**
+     * - Version of the doctype
+     */
+    doctypeVersion?: number;
+    /**
+     * - Version of the metadata
+     */
+    metadataVersion?: number;
+    /**
+     * - Date of creation
+     */
+    createdAt?: string;
+    /**
+     * - Slug of the app that created the document
+     */
+    createdByApp?: string;
+    /**
+     * - Version of the app that created the document
+     */
+    createdByAppVersion?: string;
+    /**
+     * - Date of the last update
+     */
+    updatedAt?: string;
+    /**
+     * - List of apps that updated the document
+     */
+    updatedByApps?: UpdatedByApp[];
+    /**
+     * - Id of the account associated to the document
+     */
+    sourceAccount?: string;
+    /**
+     * - Identifier of the source account
+     */
+    sourceAccountIdentifier?: string;
+    /**
+     * - Whether the document is marked as favorite
+     */
+    favorite?: boolean;
+};
 /**
  * - A document
  */
@@ -673,7 +729,7 @@ export type CozyClientDocument = {
     /**
      * - Cozy Metadata
      */
-    cozyMetadata?: object;
+    cozyMetadata?: CozyMetadata;
 };
 /**
  * - A io.cozy.files document's metadata
@@ -719,6 +775,10 @@ export type FileMetadata = {
      * - Image EXIF date, if relevant
      */
     datetime?: string;
+    /**
+     * - Name of the instance
+     */
+    instanceName?: string;
 };
 /**
  * - An io.cozy.files document
@@ -732,6 +792,14 @@ export type FileDocument = {
      * - Doctype of the file
      */
     _type: FilesDoctype;
+    /**
+     * - Id of the parent folder
+     */
+    dir_id: string;
+    /**
+     * - Path of the file
+     */
+    path?: string;
     /**
      * - Name of the file
      */