# hornet-js-bean

> Ensemble des décorateurs pour les beans hornet-js

Latest version **5.5.0-rc.4** (published 2020-04-06) · CECILL-2.1 license · 0 weekly downloads

## Install

```sh
npm install hornet-js-bean
pnpm add hornet-js-bean
yarn add hornet-js-bean
bun add hornet-js-bean
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.5.0-rc.4 |
| Published | 2020-04-06 |
| First published | 2018-04-14 |
| Weekly downloads | 0 |
| License | CECILL-2.1 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 185 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | MEAE - Ministère de l'Europe et des Affaires étrangères |
| Maintainers | moulinw |

## Links

- npm: https://www.npmjs.com/package/hornet-js-bean
- Repository: https://github.com/diplomatiegouvfr/hornet-js
- Homepage: https://github.com/diplomatiegouvfr/hornet-js#readme
- Issues: https://github.com/diplomatiegouvfr/hornet-js/issues
- npm.io page: https://npm.io/package/hornet-js-bean

## Dependencies (9)

- [chai](https://npm.io/package/chai.md) 4.2.0
- [tslib](https://npm.io/package/tslib.md) 1.10.0
- [lodash.map](https://npm.io/package/lodash.map.md) 4.6.0
- [lodash.clone](https://npm.io/package/lodash.clone.md) 4.5.0
- [lodash.foreach](https://npm.io/package/lodash.foreach.md) 4.5.0
- [hornet-js-utils](https://npm.io/package/hornet-js-utils.md) 5.5.0-rc.4
- [hornet-js-logger](https://npm.io/package/hornet-js-logger.md) 5.5.0-rc.4
- [lodash.clonedeep](https://npm.io/package/lodash.clonedeep.md) 4.5.0
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) 0.1.13

## Recent versions

- 5.5.0-rc.4 (latest) — 2020-04-06
- 5.4.1 — 2019-07-25
- 5.4.0 — 2019-07-25
- 5.4.0-RC1 — 2019-05-27
- 5.3.0 — 2019-03-28
- 5.2.4 — 2019-01-10
- 5.2.3 — 2018-11-23
- 5.2.2 — 2018-10-17
- 5.2.1 — 2018-10-12
- 5.2.0 — 2018-08-10
- 5.1.1 — 2018-04-14

## README

# hornet-js-bean

hornet-js-bean fournit un module pour la gestion des beans afin de faire du mapping entre objets.
Ce module est basé sur les annotations *@Bean* et *@Map*.

## Prérequis #

* NodeJS 10.X

## Utilisation dans un projet #

Ajouter au package.json

```shell
  "dependencies": {
    "hornet-js-bean": "5.5.X"
  }
```

Puis lancer la commande :

```shell
npm install
```

### Définition d'un Bean Hornet

voici un exemple de configuration d'un objet métier:
on déclare notre objet en tant que bean hornet à l'aide de @Bean.
Puis, on définit les champs que l'on veut mapper.


```javascript

import Bean from "hornet-js-bean/src/decorators/Bean";
import Map from "hornet-js-bean/src/decorators/Map";

@Bean
export class ObjetMetier {

    @Map()
    id: number = 0;

    @Map()
    nom: string;

    desc: string = 'dummy';
}

```

## Utilisation du mapper

Le projet hornet-js-bean fournit une classe *BeanUtils* qui fournit des opérateurs sur les Beans Hornet.
Tous ces opérateurs renvoient une Promise.

* **mapObject** : Méthode statique qui permet de mapper un objet <source> vers un objet de type <targetClass>
* **mapArray** : Méthode statique qui permet de mapper un tableau <source> vers un tableau de type <targetClass>
* **map** : Méthode statique qui permet de mapper une instance <source> vers un objet de type <targetClass>
* **serializeObject** : Méthode statique qui permet de sérialiser un objet <source> vers un objet de type <targetClass>
* **serializeArray** : Méthode statique qui permet de sérialiser un tableau <source> vers un tableau de type <targetClass>
* **serialize** : Méthode statique qui permet de sérialiser une instance <source> vers un objet de type <targetClass>
* **cloneObject** : Méthode statique qui permet de cloner un objet <source> vers un nouvel objet de même type
* **cloneArray** : Méthode statique qui permet de cloner un tableau <source> vers un nouveau tableau de même type
* **clone** : Méthode statique qui permet de cloner une instance <source> vers un nouvel objet de même type

Voici un exemple qui permet de créer un objet ObjetMetier à partir d'un objet existant.

```javascript

import {BeanUtils} from "hornet-js-bean/src/bean-utils";

...
let source = {
    id : 1,
    nom : 'nom',
    prenom: 'prenom',
    desc : 'desc'};

BeanUtils.mapObject(ObjetMetier,source).then((result:ObjetMetier) =>{
    result.id //<= 1
    result.nom //<= 'nom'
    result.desc //<= 'dummy'
    //l'attribut prénom n'existe pas dans result
});
...

```

### Utilisation du mapper via l'annotation @Map sur une Promise

Si une fonction renvoie une promesse de résultat, il est possible de chainer le mapping de deux façons:

```javascript

    getObjetMetier() : Promise<ObjetMetier>{
        return New Promise<>(resolve, reject).then((source) => {
            return BeanUtils.mapObject(ObjetMetier,source))
        }
    }

est équivalent à

    @Map(ObjetMetier)
    getObjetMetier() : Promise<ObjetMetier>{
        return New Promise<>(resolve, reject)
    }
```

### Utilisation du mapper via l'annotation @Map sur les paramètres d'une fonction qui renvoie une Promise


Pour transformer un object metier en DTO par exemple, on peut procéder de la manière suivante:
Attention, il ne faut pas oublier de mettre une annotation sur la fonction pour lui dire de faire la transformation!

```javascript

    @Map()
    getObjetMetier(@Map(ObjectDTO)metier) : Promise<ObjetMetier>{
        //ici metier sera transformé automatiquement en un objetDTO
        return insert(metier)
    }
```

### Utilisation du mapper avec des alias

Il se peut que les noms des attributs diffèrent entre l'objet source et l'object de destination
L'annotation @Alias permet de configurer 1 ou plusieurs alias (l'ordre est important ici=>Le premier qui match est retenu).
Reprenons l'exemple ci-dessus:

```javascript

@Bean
export class ObjetMetier {

    @Map()
    id: number = 0;

    @Map()
    nom: string;

    @Map()
    @Alias('description')
    desc: string = 'dummy';
}

import {BeanUtils} from "hornet-js-bean/src/bean-utils";

...
let source = {
    id : 1,
    nom : 'nom',
    prenom: 'prenom',
    description : 'desc'};

BeanUtils.mapObject(ObjetMetier,source).then((result:ObjetMetier) =>{
    result.id //<= 1
    result.nom //<= 'nom'
    result.desc //<= 'desc'
});
...

```
## Licence

`hornet-js-bean` est sous [licence cecill 2.1](./LICENSE.md).

Site web : [http://www.cecill.info](http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.html)

---
_Source: https://npm.io/package/hornet-js-bean · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
