feat: Add support for io.cozy.bills in models/paper

cozy · May 28, 2024 · 663e27f · 663e27f
1 parent 1bf1593
commit 663e27f
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 23 deletions.
diff --git a/docs/api/cozy-client/modules/models.paper.md b/docs/api/cozy-client/modules/models.paper.md
@@ -18,14 +18,24 @@
 
 ### MetadataQualificationType
 
-Ƭ **MetadataQualificationType**<>: `"date"` | `"information"` | `"contact"` | `"other"`
+Ƭ **MetadataQualificationType**<>: `"date"` | `"information"` | `"contact"` | `"other"` | `"bills"`
 
 *Defined in*
 
-[packages/cozy-client/src/models/paper.js:275](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L275)
+[packages/cozy-client/src/models/paper.js:276](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L276)
 
 ## Variables
 
+### KNOWN_BILLS_ATTRIBUTES_NAMES
+
+• `Const` **KNOWN_BILLS_ATTRIBUTES_NAMES**: `string`\[]
+
+*Defined in*
+
+[packages/cozy-client/src/models/paper.js:51](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L51)
+
+***
+
 ### KNOWN_DATE_METADATA_NAMES
 
 • `Const` **KNOWN_DATE_METADATA_NAMES**: `string`\[]
@@ -76,7 +86,7 @@ Expiration date
 
 *Defined in*
 
-[packages/cozy-client/src/models/paper.js:125](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L125)
+[packages/cozy-client/src/models/paper.js:126](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L126)
 
 ***
 
@@ -100,7 +110,7 @@ Expiration notice date
 
 *Defined in*
 
-[packages/cozy-client/src/models/paper.js:161](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L161)
+[packages/cozy-client/src/models/paper.js:162](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L162)
 
 ***
 
@@ -124,7 +134,7 @@ Expiration notice link
 
 *Defined in*
 
-[packages/cozy-client/src/models/paper.js:180](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L180)
+[packages/cozy-client/src/models/paper.js:181](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L181)
 
 ***
 
@@ -146,7 +156,7 @@ Formatted and translated value of an array of contact
 
 *Defined in*
 
-[packages/cozy-client/src/models/paper.js:442](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L442)
+[packages/cozy-client/src/models/paper.js:448](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L448)
 
 ***
 
@@ -171,7 +181,7 @@ Formatted and translated value for the metadata
 
 *Defined in*
 
-[packages/cozy-client/src/models/paper.js:321](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L321)
+[packages/cozy-client/src/models/paper.js:326](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L326)
 
 ***
 
@@ -197,7 +207,7 @@ Formatted and translated value for the metadata
 
 *Defined in*
 
-[packages/cozy-client/src/models/paper.js:364](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L364)
+[packages/cozy-client/src/models/paper.js:369](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L369)
 
 ***
 
@@ -221,7 +231,7 @@ Formatted and translated value for the metadata
 
 *Defined in*
 
-[packages/cozy-client/src/models/paper.js:244](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L244)
+[packages/cozy-client/src/models/paper.js:245](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L245)
 
 ***
 
@@ -246,7 +256,7 @@ Formatted and translated value for the metadata
 
 *Defined in*
 
-[packages/cozy-client/src/models/paper.js:417](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L417)
+[packages/cozy-client/src/models/paper.js:423](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L423)
 
 ***
 
@@ -270,7 +280,7 @@ The type of the metadata
 
 *Defined in*
 
-[packages/cozy-client/src/models/paper.js:283](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L283)
+[packages/cozy-client/src/models/paper.js:284](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L284)
 
 ***
 
@@ -293,7 +303,7 @@ Translated name for contact
 
 *Defined in*
 
-[packages/cozy-client/src/models/paper.js:432](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L432)
+[packages/cozy-client/src/models/paper.js:438](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L438)
 
 ***
 
@@ -317,7 +327,7 @@ Translated name for the metadata
 
 *Defined in*
 
-[packages/cozy-client/src/models/paper.js:308](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L308)
+[packages/cozy-client/src/models/paper.js:313](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L313)
 
 ***
 
@@ -342,7 +352,7 @@ Translated name for the metadata
 
 *Defined in*
 
-[packages/cozy-client/src/models/paper.js:341](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L341)
+[packages/cozy-client/src/models/paper.js:346](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L346)
 
 ***
 
@@ -366,7 +376,7 @@ Translated name for the metadata
 
 *Defined in*
 
-[packages/cozy-client/src/models/paper.js:404](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L404)
+[packages/cozy-client/src/models/paper.js:410](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L410)
 
 ***
 
@@ -388,7 +398,7 @@ Translated name for the metadata
 
 *Defined in*
 
-[packages/cozy-client/src/models/paper.js:192](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L192)
+[packages/cozy-client/src/models/paper.js:193](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L193)
 
 ***
 
@@ -410,7 +420,7 @@ Translated name for the metadata
 
 *Defined in*
 
-[packages/cozy-client/src/models/paper.js:107](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L107)
+[packages/cozy-client/src/models/paper.js:108](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L108)
 
 ***
 
@@ -432,7 +442,7 @@ Translated name for the metadata
 
 *Defined in*
 
-[packages/cozy-client/src/models/paper.js:204](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L204)
+[packages/cozy-client/src/models/paper.js:205](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L205)
 
 ***
 
@@ -454,7 +464,7 @@ Translated name for the metadata
 
 *Defined in*
 
-[packages/cozy-client/src/models/paper.js:481](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L481)
+[packages/cozy-client/src/models/paper.js:487](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L487)
 
 ***
 
@@ -475,7 +485,7 @@ Translated name for the metadata
 
 *Defined in*
 
-[packages/cozy-client/src/models/paper.js:453](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L453)
+[packages/cozy-client/src/models/paper.js:459](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L459)
 
 ***
 
@@ -497,4 +507,4 @@ Translated name for the metadata
 
 *Defined in*
 
-[packages/cozy-client/src/models/paper.js:465](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L465)
+[packages/cozy-client/src/models/paper.js:471](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/paper.js#L471)
diff --git a/packages/cozy-client/src/models/document/locales/en.json b/packages/cozy-client/src/models/document/locales/en.json
@@ -239,6 +239,9 @@
           "noticePeriod": "Expiration alert",
           "netSocialAmount": "Net social amount",
           "employerName": "Name of employer",
+          "employer": "Name of employer",
+          "amount": "Amount of expenditure",
+          "subtype": "Purpose of expenditure",
           "bicNumber": "BIC number"
         },
         "day": "day |||| days"

diff --git a/packages/cozy-client/src/models/document/locales/fr.json b/packages/cozy-client/src/models/document/locales/fr.json
@@ -239,6 +239,9 @@
           "noticePeriod": "Alerte d’expiration",
           "netSocialAmount": "Montant net social",
           "employerName": "Nom de l'employeur",
+          "employer": "Nom de l'employeur",
+          "amount": "Montant de la dépense",
+          "subtype": "Objet de la dépense",
           "bicNumber": "Numéro BIC"
         },
         "day": "jour |||| jours"

diff --git a/packages/cozy-client/src/models/paper.js b/packages/cozy-client/src/models/paper.js
@@ -48,6 +48,7 @@ export const KNOWN_INFORMATION_METADATA_NAMES = [
   'noticePeriod'
 ]
 export const KNOWN_OTHER_METADATA_NAMES = ['contact', 'page', 'qualification']
+export const KNOWN_BILLS_ATTRIBUTES_NAMES = ['amount', 'subtype', 'employer']
 
 /**
  * @param {IOCozyFile} file - io.cozy.files document
@@ -272,7 +273,7 @@ export const formatMetadataQualification = metadata => {
 }
 
 /**
- * @typedef {('date' | 'information' | 'contact' | 'other')} MetadataQualificationType
+ * @typedef {('date' | 'information' | 'contact' | 'other' | 'bills')} MetadataQualificationType
  */
 
 /**
@@ -296,6 +297,10 @@ export const getMetadataQualificationType = metadataName => {
     return 'other'
   }
 
+  if (KNOWN_BILLS_ATTRIBUTES_NAMES.includes(metadataName)) {
+    return 'bills'
+  }
+
   return null
 }
 
@@ -383,6 +388,7 @@ export const formatInformationMetadataValue = (
   if (
     name === 'refTaxIncome' ||
     name === 'netSocialAmount' ||
+    name === 'amount' ||
     (name === 'number' && qualificationLabel === 'pay_sheet')
   ) {
     return `${value} €`

diff --git a/packages/cozy-client/types/models/paper.d.ts b/packages/cozy-client/types/models/paper.d.ts
@@ -1,6 +1,7 @@
 export const KNOWN_DATE_METADATA_NAMES: string[];
 export const KNOWN_INFORMATION_METADATA_NAMES: string[];
 export const KNOWN_OTHER_METADATA_NAMES: string[];
+export const KNOWN_BILLS_ATTRIBUTES_NAMES: string[];
 export function isExpiring(file: IOCozyFile): boolean;
 export function computeExpirationDate(file: IOCozyFile): Date | null;
 export function computeExpirationNoticeDate(file: IOCozyFile): Date | null;
@@ -49,4 +50,4 @@ 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";
+export type MetadataQualificationType = "other" | "date" | "contact" | "information" | "bills";