Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
May 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 31 additions & 21 deletions docs/api/cozy-client/modules/models.paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`\[]
Expand Down Expand Up @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)
3 changes: 3 additions & 0 deletions packages/cozy-client/src/models/document/locales/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
3 changes: 3 additions & 0 deletions packages/cozy-client/src/models/document/locales/fr.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
8 changes: 7 additions & 1 deletion packages/cozy-client/src/models/paper.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -272,7 +273,7 @@ export const formatMetadataQualification = metadata => {
}

/**
* @typedef {('date' | 'information' | 'contact' | 'other')} MetadataQualificationType
* @typedef {('date' | 'information' | 'contact' | 'other' | 'bills')} MetadataQualificationType
*/

/**
Expand All @@ -296,6 +297,10 @@ export const getMetadataQualificationType = metadataName => {
return 'other'
}

if (KNOWN_BILLS_ATTRIBUTES_NAMES.includes(metadataName)) {
return 'bills'
}

return null
}

Expand Down Expand Up @@ -383,6 +388,7 @@ export const formatInformationMetadataValue = (
if (
name === 'refTaxIncome' ||
name === 'netSocialAmount' ||
name === 'amount' ||
(name === 'number' && qualificationLabel === 'pay_sheet')
) {
return `${value} €`
Expand Down
3 changes: 2 additions & 1 deletion packages/cozy-client/types/models/paper.d.ts
Original file line number Diff line number Diff line change
@@ -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;
Expand Down Expand Up @@ -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";
Loading