---
title: migrate
slug: oip-next/v3/tools/core/migrate
icon: {"lucideIcon":"📘"}
createdAt: 2025-10-13T12:36:36.000Z
---

# Introduction

La commande *migrate* permet de générer un rapport de migration entre la version de l'OIP Core utilisée par un projet et la version supérieure passée en paramètre.

Le rapport contient plusieurs sections :

1. Une section listant l'ensemble des versions disponibles de l'OIP Core.
2. Une section *breaking changes* :
   - Pour chaque entité :
     - `removed` : indique si l'entité a été supprimée
     - `deprecated` : indique si l'entité a été dépréciée
   - Pour chaque propriété :
     - `removed` : indique si la propriété a été supprimée
     - `deprecated` : indique si la propriété a été dépréciée
     - `type` : indique si le type de la propriété a été modifié ; le format est `{value_before} => {value_after}`
     - `read-only` : indique si la propriété est désormais en lecture seule ou non ; le format est `{value_before} => {value_after}`
     - `validator` : indique si le validateur associé à la propriété a été modifié ; le format est `{value_before} => {value_after}`
     - `enum` : indique si les valeurs de l'énumération associées à la propriété ont été modifiées ; le format est `{value_before} => {value_after}`
3. Une section *usages* listant les utilisations de l'OIP Core dans le projet qui nécessitent une modification pour migrer vers la nouvelle version.

### Afficher un rapport des différences de votre version actuelle et celle passée en paramètre : *migrate*

Cette commande va générer un rapport d'état des lieux entre votre version actuelle de l'OIP Core et celle passée en paramètre.

```shell
oip-tools core migrate <version-cible>
```

*Remarques* :

- Vous ne pouvez executer cette commande que sur votre projet
- La version passée en paramètre doit exister dans le registre `npm`. [cf. le référentiel](https://www.npmjs.com/package/@fasstech/oip-core?activeTab=versions)

# Exemple

```shell
oip-tools core migrate 2.4.0
```

````markdown
# Migration report
​
From version: `2.2.0`
​
To version: `2.4.0`
​
Available versions:
​
- `2.0.0`
- `2.0.0-rc.6`
- `2.1.0`
- `2.1.1`
- `2.1.2`
- `2.2.0`
- `2.2.1`
- `2.3.0-rc.0`
- `2.4.0`
​
## Breaking changes
​
The breaking changes are listed by entity.
​
For each entity:
​
- `removed`: entity no longer exists in the target version
  - `x` means a removal
- `deprecated`: entity is deprecated in the target version
  - `x` means a deprecation
​
For each entity property:
​
- `removed`: property no longer exists in the target version
  - `x` means a removal
- `deprecated`: property is deprecated in the target version
  - `x` means a deprecation
- `type`: a value means a change happened
  - format is `{value_before} => {value_after}`
- `read-only`: a value means a change happened
  - format is `{value_before} => {value_after}`
- `validator`: a value means a change happened
  - format is `{value_before} => {value_after}`
- `enum`: a value means a change happened
  - format is `{value_before} => {value_after}`
​
### Address
​
| Removed? | Deprecated? |
| :------: | :---------: |
​
​
#### Properties
​
| Name | Removed? | Deprecated? | Type | Read-only | Validator | Enum |
| ---- | :------: | :---------: | ---- | --------- | --------- | ---- |
| city |  |  |  |  |  |  |
| country |  |  |  |  |  |  |
| department |  |  |  |  |  |  |
| fields |  |  |  |  |  |  |
| postalCode |  |  |  |  | null => {"exactLength":null,"minLength":null,"maxLength":null,"type":["postal"]} |  |
| zipCode |  |  |  |  |  |  |
​
### Contact
​
| Removed? | Deprecated? |
| :------: | :---------: |
​
​
#### Properties
​
| Name | Removed? | Deprecated? | Type | Read-only | Validator | Enum |
| ---- | :------: | :---------: | ---- | --------- | --------- | ---- |
| civility |  |  |  |  |  |  |
| email |  |  |  |  |  |  |
| firstName |  |  |  |  |  |  |
| isPEP |  |  |  |  |  |  |
| isRecipient |  |  |  |  |  |  |
| isSignatory |  |  |  |  |  |  |
| lastName |  |  |  |  |  |  |
| mobilePhoneIndicative |  |  |  |  |  |  |
| mobilePhoneNumber |  |  |  |  |  |  |
| phoneIndicative |  |  |  |  |  |  |
| phoneNumber |  |  |  |  |  |  |
| role |  |  |  |  |  | [ACCOUNTANT, FINANCIAL_OFFICER, HR_MANAGER, LEGAL_REPRESENTATIVE] => [ACCOUNTANT, ADMINISTRATIVE_MANAGER, COMMERCIAL, FINANCIAL_OFFICER, HEAD_MANAGER, HR_MANAGER, LEGAL_REPRESENTATIVE, MANAGER] |
​
### Customer
​
| Removed? | Deprecated? |
| :------: | :---------: |
​
​
#### Properties
​
| Name | Removed? | Deprecated? | Type | Read-only | Validator | Enum |
| ---- | :------: | :---------: | ---- | --------- | --------- | ---- |
| SSNumber |  |  |  |  |  |  |
| birthCity |  |  |  |  |  |  |
| birthCountry |  |  |  |  |  |  |
| birthDate |  |  |  |  |  |  |
| birthDatePartner |  |  |  |  |  |  |
| birthName |  |  |  |  |  |  |
| civility |  |  |  |  |  |  |
| corporateName |  |  |  |  |  |  |
| dependentChildren |  |  |  |  |  |  |
| email |  |  |  |  |  |  |
| firstName |  |  |  |  |  |  |
| hasCertifiedOnTheHonor |  |  |  |  |  |  |
| hasRelationPoliticallyExposed |  |  |  |  |  |  |
| isMember |  |  |  |  |  |  |
| isPoliticallyExposed |  |  |  |  |  |  |
| isTns |  |  |  |  |  |  |
| lastName |  |  |  |  |  |  |
| maritalStatus |  |  |  |  |  |  |
| mobilePhoneIndicative |  |  |  |  |  |  |
| mobilePhoneNumber |  |  |  |  |  |  |
| nationality |  |  |  |  |  |  |
| phoneIndicative |  |  |  |  |  |  |
| phoneNumber |  |  |  |  |  |  |
| professionalActivity |  |  |  |  |  |  |
| professionalStatus |  |  |  |  |  |  |
| regime |  |  |  |  |  | [REGIME_AGRICOLE, REGIME_GLOBAL, REGIME_LOCAL] => [REGIME_AGRICOLE, REGIME_GLOBAL, REGIME_INDEPENDANT, REGIME_LOCAL] |
| regimeSpecification |  |  |  |  |  |  |
| retirementAge |  |  |  |  |  |  |
​
### Grantee
​
| Removed? | Deprecated? |
| :------: | :---------: |
​
​
#### Properties
​
| Name | Removed? | Deprecated? | Type | Read-only | Validator | Enum |
| ---- | :------: | :---------: | ---- | --------- | --------- | ---- |
| birthCity |  |  |  |  |  |  |
| birthCountry |  |  |  |  |  |  |
| birthDate |  |  |  |  |  |  |
| birthName |  |  |  |  |  |  |
| civility |  |  |  |  |  |  |
| firstName |  |  |  |  |  |  |
| hasEducationAnnuityBeneficiary |  |  |  |  |  |  |
| hasHealthContract |  |  |  |  |  |  |
| hasProtectionContract |  |  |  |  |  |  |
| id |  |  |  | false => true |  |  |
| lastName |  |  |  |  |  |  |
| percentShare |  |  |  |  |  |  |
| type |  |  |  |  |  | [Conjoint, Enfant] => [CHILD, SPOUSE] |
​
### Offer
​
| Removed? | Deprecated? |
| :------: | :---------: |
​
​
#### Properties
​
| Name | Removed? | Deprecated? | Type | Read-only | Validator | Enum |
| ---- | :------: | :---------: | ---- | --------- | --------- | ---- |
| college |  |  |  |  |  |  |
| createdAt |  |  |  |  |  |  |
| createdBy |  |  |  |  |  |  |
| dateRia |  |  |  |  |  |  |
| defaultPrice |  |  |  |  |  |  |
| effectDate |  |  |  |  |  |  |
| employeeAverageAge |  |  |  |  |  |  |
| employeeCount |  |  |  |  |  |  |
| employerPercentShare |  |  |  |  |  |  |
| externalId |  |  |  |  |  |  |
| hasHealthContract |  |  |  |  |  |  |
| hasProtectionContract |  |  |  |  |  |  |
| increase |  |  |  |  |  |  |
| isRia |  |  |  |  |  |  |
| level |  |  |  |  |  |  |
| longLabel |  |  |  |  |  |  |
| maxAge |  |  |  |  |  |  |
| maxEffectDate |  |  |  |  |  |  |
| minAge |  |  |  |  |  |  |
| minEffectDate |  |  |  |  |  |  |
| name |  |  |  |  |  |  |
| need |  |  |  |  |  |  |
| price |  |  |  |  |  |  |
| regime |  |  |  |  |  | [REGIME_AGRICOLE, REGIME_GLOBAL, REGIME_LOCAL] => [REGIME_AGRICOLE, REGIME_GLOBAL, REGIME_INDEPENDANT, REGIME_LOCAL] |
| riskAndRange |  |  |  |  |  |  |
| shortLabel |  |  |  |  |  |  |
| status |  |  |  |  |  |  |
| supplInsuranceExtGuarantee |  |  |  |  |  |  |
| supplInsuranceNeeded |  |  |  |  |  |  |
| supplInsurancePayer |  |  |  |  |  |  |
| tariffStructure |  |  |  |  |  |  |
| type |  |  |  |  |  |  |
| updatedAt |  |  |  |  |  |  |
| updatedBy |  |  |  |  |  |  |
​
## New features
​
### Added entities
​
- ActivePolicy: Informations du/des contrat(s) en cours chez un assureur tiers. Rattaché à l'entité Customer.
- Aml: L'Entité AML (Anti Money Laundering) est rattachée à Company, Customer, Grantee, Contact afin de stocker les indicateurs de risque AML liés à la personne physique ou morale.
- ChosenRiskAndRange: L'entité ChosenRiskAndRange regroupe les risques choisis, la date d'effet souhaitée et le(s) colleges. Elle est lié à l'entité project sous forme de tableau de ChosenRiskAndRange
- Commission: L'entité commission correspond à la commission touchée par l’agent pour une formule donnée. Elle est rattachée à l’entité pack sous forme de tableau.
- Email: Cette entité contient la valeur de l’email  ainsi que son type. L'entité Email est rattachée aux entités User, Company, Customer, Contact et Grantee sous forme de tableau.
- Employee: L'entité Employee va contenir les information des salariées lors d’un contrat d'épargne collective. Elle est lié à l'entité Demography sous forme de tableau.
- FinanceCompany: L'entité Finance est liée à l'entité Company et regroupe les informations financières relative à celle-ci.
- InvestmentBreakdown: Entité permettant de gérer la répartition des investissements sur différent fond de placements
- Pack: L'entité pack correspond à une formule. elle est lié à l'entité offer sous forme de tableau de pack.
- Phone: L'entité Phone contient les différentes informations concernant la structure d’un téléphone ainsi que son type.
- Price: L'entité price correspond au détail de la structure tarifaire pricing. Elle est lié à l'entité Pricing sous forme de tableau.
- Pricing: L'entité pricing correspond à la structure tarifaire de la formule. Elle est lié à l'entité pack sous forme de tableau.
- SocialSecurity: Informations de sécurité sociale relatives au bénéficiaire.
- Svc: Regroupe les informations nécessaires relatives aux services interne et externe de l'OAV.
​
### Added properties
​
- CollectionNeed#id: Identifiant unique de CollectionNeed
- Company#acronym: Acronyme
- Company#externalId: Identifiant externe
- Company#id: Identifiant unique de l'entreprise
- Company#website: Site web de l'établissement
- Contact#externalId: Identifiant externe du contact
- Contact#id: Identifiant unique du contact
- Customer#externalId: Identifiant externe
- Customer#healthReimbursementMethod: Mode de remboursement
- Customer#isAlsaceMoselle: Depend ou non du regime d'alsace moselle
- Customer#isDigitalContract: 
- Customer#isDigitalHealthInsuranceCard: 
- Customer#isMadelin: La « loi Madelin » permet au travailleur non salarié (TNS) de déduire de son revenu imposable les cotisations sur un contrat Madelin
- Demography#id: Identifiant unique de la demographie
- Demography#riskAndRange: Risque et gamme
- Document#id: Identifiant unique du document
- Document#mimeType: Type mime du fichier
- Document#type: Type du document
- Grantee#attachedSocialSecurity: Bénéficiaire attaché à, max 2 entrées: première entrée = adhérent et seconde entrée = conjoint
- Grantee#externalId: Identifiant externe du bénéficiaire
- HealthNeed#id: Identifiant unique de HealthNeed
- Offer#demographyId: Identifiant unique de la démographie
- Offer#id: Identifiant unique de l'offre
- ProtectionNeed#id: Identifiant unique de ProtectionNeed
- Signature#date: Date de signature du contrat
- Signature#numberOfSendings: Nombre d'envois en signature
- StatusHistory#metadata: Données additionnelles/informatives liées à l'évènement
- StatusHistory#type: Indique le type d'évènement lié au statut. "OPERATIONAL" est relatif au cycle de vie "métier" de l'OAV. "TECHNICAL" sert pour stocket des évènements techniques (audit/traçabilité, etc).
- User#id: Identifiant unique de l'utilisateur
​
## Usages
​
```
../../playground/projectFile/views/simulation1/server/graphql/resolver/saveSimulation1.mjs
​
Ln 45, Col 27: setAddressPostalCode
​
statement might be changed; property validator has been modified: null => {"exactLength":null,"minLength":null,"maxLength":null,"type":["postal"]}
```
​
```
../../playground/projectFile/views/souscription2/server/graphql/resolver/saveSubscription2.mjs
​
Ln 146, Col 7: setAddressPostalCode
​
statement might be changed; property validator has been modified: null => {"exactLength":null,"minLength":null,"maxLength":null,"type":["postal"]}
```
​
```
../../playground/projectFile/views/souscription3/server/graphql/resolver/saveSubscription3.mjs
​
Ln 44, Col 5: setAddressPostalCode
​
statement might be changed; property validator has been modified: null => {"exactLength":null,"minLength":null,"maxLength":null,"type":["postal"]}
```
​
```
../../playground/projectFile/server/helpers/editique/formatBAValues.mjs
​
Ln 126, Col 49: getGranteeType
​
statement might be changed; property enum has been modified: [Conjoint, Enfant] => [CHILD, SPOUSE]
```
````
