Es Mapping TS


This library is used to generate elasticsearch mapping through typescript decorators

Installation

``sh
npm install es-mapping-ts --save
`

Peer dependencies

This package only work with @elastic/elasticsearch

Version

$3

* elasticsearch 7
* elasticsearch 6
* elasticsearch 5

Examples

$3

`typescript
import { EsEntity, EsField } from 'es-mapping-ts';
import { ObjectEntity } from './object.entity';
import { NestedEntity } from './nested.entity';

@EsEntity({
index: 'master',
type: 'masterType'
})
export class MasterEntity {

@EsField({
type : 'text'
})
name?: string;

@EsField({
type: 'text',
copy_to : 'name'
})
firstname: string;

@EsField({
type: 'text',
copy_to : 'name'
})
lastname: string;

@EsField({
type: 'join',
relations: { 'master': 'submaster' }
})
master: Array;

@EsField({
type: 'object',
fieldClass: ObjectEntity
})
objects: Array;

@EsField({
type: 'nested',
fieldClass: NestedEntity
})
nested: Array;
}
`

`typescript
import { EsEntity, EsField } from 'es-mapping-ts';

@EsEntity({
index: 'nested'
})
export class NestedEntity {

@EsField({
type: 'text',
})
name: string;

@EsField({
type: 'integer'
})
montant: number;
}
`

`typescript
import { EsEntity, EsField } from 'es-mapping-ts';

// This es entity is only here for field mapping,
// it's not supposed to have is own index
@EsEntity()
export class ObjectEntity {

@EsField({
type: 'text',
analyzer : 'whitespace'
})
name: string;

@EsField({
type: 'integer',
})
age: number;
}
`

$3

#### Simply call the "uploadMappings" function

`typescript
import { EsMappingService } from 'es-mapping-ts';
import { Client } from '@elastic/elasticsearch';

const esClient = new Client({
host: 'http://localhost:9200',
log : 'info'
});

// Upload the mapping
const mappings = EsMappingService.getInstance().uploadMappings(esClient);
`

only none readonly entity will be uploaded

#### or do it yourself

`typescript
import { EsMappingService } from 'es-mapping-ts';

//List of ready to use generated mapping
const mappings = EsMappingService.getInstance().getMappings();

Bluebird.each(mappings, async (mapping) => {
//create index
await esclient.indices.create({ index: mapping.index });

//create mapping
await esclient.indices.putMapping(mapping);
});
`

$3

You can also extend EsMapping

`typescript
export class AbstractEntity {

@EsField({
type: 'text',
})
abstractName: string;

@EsField({
type: 'text',
})
overridableName: string;
}
`

`typescript
@EsEntity({
index: 'concret',
type: 'typeConcret'
})
export class ConcretEntity extends AbstractEntity {

@EsField({
type: 'text'
})
concretName: string;


@EsField({
type: 'text',
null_value : 'undefined'
})
overridableName: string;
}
`




$3

You can add mixins to your entities by declaring an entity like so:

`typescript
@EsEntity({ mixins: [BaseMixin] })
export class SomeEntity {
@EsField({
type: "text",
})
name: string;
}
`

The mixin class looks like:

`typescript
@EsEntity()
export class BaseMixin {
@EsField({
type: "keyword"
})
id: string;

@EsField({
name: "start_date",
type: "date"
})
startDate: Date;

@EsField({
name: "end_date",
type: "date"
})
endDate: Date;
}
`

SomeClass will now have a mapping like:

`json
{
"body": {
"properties": {
"name": {
"type": "text",
},
"id": {
"type": "keyword",
},
"start_date": {
"name": "start_date",
"type": "date",
},
"end_date": {
"name": "end_date",
"type": "date",
},
}
}
}
`

Decorators

$3

| Param | Type | Description |
| ------ | ------ | ------ |
| index | string | Allow you to define the index name |
| type | string | Allow you to define the index type |
| readonly | boolean | Define if the mapping must be uploaded when using uploadMappings function |
| mixins | Array | Allow you to compose with one or more EsEntities, see "Using mixins" |

$3

| Param | Type | Description |
| ------ | ------ | ------ |
| type | string | Allow you to define the type of the index |
| name | string | Allow you to define the name of the property if different from the property name |
| dynamic | boolean | Allow you to define if the field can accept additional properties |
| analyzer | string | Allow you to define the elasticsearch analyzer |
| fields | string | Allow you to define the elasticsearch fields |
| format | string | Allow you to define the format (ie for date field) |
| enabled | boolean | Allow you to enable ou disable the field |
| null_value | string | Allow you to define the null value of the field |
| copy_to | string | Allow you to copy the field value into a group field for _search |
| relations | string | Define the releation for a join type |
| fieldClass | string | Class used to get the properties of the nested or object array type |

Additional properties are allowed, allowing you to manage other elasticsearch properties

How to dev

$3

`shell


launch unit testing

npm run test

build

npm run build
`

This project is also managed by travis for CI

$3

`
npm run build
npm run test

mkdir release
cp -r dist release
cp LICENSE release
cp README.md release
cp package.json release #change version

cd relese
npm publish
``

License

----

MIT