Skip to content
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
73 changes: 73 additions & 0 deletions .commitlintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
{
"parserPreset": "conventional-changelog-conventionalcommits",
"rules": {
"body-leading-blank": [
1,
"always"
],
"body-max-line-length": [
2,
"always",
100
],
"footer-leading-blank": [
1,
"always"
],
"header-max-length": [
2,
"always",
100
],
"scope-case": [
2,
"always",
"lower-case"
],
"subject-case": [
2,
"never",
[
"sentence-case",
"start-case",
"pascal-case",
"upper-case"
]
],
"subject-empty": [
2,
"never"
],
"subject-full-stop": [
2,
"never",
"."
],
"type-case": [
2,
"always",
"lower-case"
],
"type-empty": [
2,
"never"
],
"type-enum": [
2,
"always",
[
"build",
"chore",
"ci",
"docs",
"feat",
"fix",
"perf",
"refactor",
"revert",
"style",
"test"
]
]
}
}
1 change: 1 addition & 0 deletions .husky/commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
yarn commitlint --edit $1
1 change: 1 addition & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
yarn lint
193 changes: 100 additions & 93 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,93 +1,100 @@
{
"name": "@codemaskjs/nestjs-elasticsearch",
"author": "Przemysław Walczak <[email protected]> (https://github.com/przemyslawwalczak)",
"repository": "https://github.com/przemyslawwalczak/nestjs-elasticsearch",
"license": "MIT",
"version": "1.10.1",
"description": "Nestjs Elasticsearch Module",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"type": "commonjs",
"packageManager": "[email protected]",
"engines": {
"node": ">= 18.0.0"
},
"commitlint": {
"extends": [
"@commitlint/config-conventional"
]
},
"eslintIgnore": [
"node_modules/"
],
"scripts": {
"test": "yarn jest --config=jest.config.json --pathPattern=src",
"build:package": "yarn tsc --declaration --project tsconfig.build.json",
"build:replace-tspaths": "yarn tscpaths -p tsconfig.build.json -s ./src -o ./dist",
"build": "yarn rimraf dist && yarn build:package && yarn build:replace-tspaths",
"lint": "yarn eslint --ext .ts src",
"format": "yarn prettier -w src && yarn lint --fix",
"generate:random-data": "yarn ts-node ./src/test/scripts/generate-random-data.ts",
"es:seed": "yarn ts-node --project tsconfig.json ./src/test/scripts/es-seed.ts"
},
"keywords": [
"nestjs",
"typescript",
"typesafe",
"nestjs-elasticsearch"
],
"dependencies": {
"@elastic/elasticsearch": "7.13.0",
"@nestjs/common": "10.2.7",
"@nestjs/elasticsearch": "9.0.0",
"class-validator": "0.14.0",
"ramda": "0.29.1",
"reflect-metadata": "0.1.13"
},
"devDependencies": {
"@commitlint/config-conventional": "18.0.0",
"@faker-js/faker": "8.2.0",
"@nestjs/core": "10.2.7",
"@nestjs/platform-express": "10.2.7",
"@nestjs/testing": "10.2.7",
"@swc/core": "1.3.94",
"@swc/jest": "0.2.29",
"@types/jest": "29.5.6",
"@types/node": "20.8.7",
"@types/ramda": "0.29.7",
"@types/supertest": "2.0.15",
"@typescript-eslint/eslint-plugin": "6.8.0",
"@typescript-eslint/eslint-plugin-tslint": "6.8.0",
"@typescript-eslint/parser": "6.8.0",
"eslint": "8.52.0",
"eslint-config-codemask": "1.1.7",
"eslint-plugin-functional": "6.0.0",
"eslint-plugin-import": "2.29.1",
"eslint-plugin-jsdoc": "46.8.2",
"eslint-plugin-jsx-a11y": "6.7.1",
"eslint-plugin-nested-if": "1.0.0",
"eslint-plugin-no-else": "0.2.2",
"eslint-plugin-no-loops": "0.3.0",
"eslint-plugin-prefer-arrow": "1.2.3",
"eslint-plugin-react": "7.33.2",
"eslint-plugin-react-hooks": "4.6.0",
"expect-more-jest": "5.5.0",
"husky": "8.0.3",
"jest": "29.7.0",
"prettier": "3.0.3",
"rimraf": "5.0.5",
"rxjs": "7.8.1",
"semantic-release": "22.0.5",
"supertest": "6.3.3",
"ts-node": "10.9.1",
"tsconfig-paths": "4.2.0",
"tscpaths": "0.0.9",
"tslint": "6.1.3",
"typescript": "5.2.2",
"wait-on": "7.0.1"
},
"publishConfig": {
"@codemaskjs:registry": "https://registry.npmjs.org/",
"access": "public"
}
}
{
"name": "@codemaskjs/nestjs-elasticsearch",
"authors": [
"Ada Krupa",
"Adrian Boratyn",
"Grzegorz Wadas",
"Przemysław Walczak"
],
"repository": "https://github.com/codemaskinc/nestjs-elasticsearch",
"license": "MIT",
"version": "1.10.1",
"description": "Nestjs Elasticsearch Module",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"type": "commonjs",
"packageManager": "[email protected]",
"engines": {
"node": ">= 18.0.0"
},
"commitlint": {
"extends": [
"@commitlint/config-conventional"
]
},
"eslintIgnore": [
"node_modules/"
],
"scripts": {
"test": "yarn jest --config=jest.config.json --pathPattern=src",
"build:package": "yarn tsc --declaration --project tsconfig.build.json",
"build:replace-tspaths": "yarn tscpaths -p tsconfig.build.json -s ./src -o ./dist",
"build": "yarn rimraf dist && yarn build:package && yarn build:replace-tspaths",
"lint": "yarn eslint --ext .ts src",
"format": "yarn prettier -w src && yarn lint --fix",
"generate:random-data": "yarn ts-node ./src/test/scripts/generate-random-data.ts",
"es:seed": "yarn ts-node --project tsconfig.json ./src/test/scripts/es-seed.ts",
"prepare": "husky"
},
"keywords": [
"nestjs",
"typescript",
"typesafe",
"nestjs-elasticsearch"
],
"dependencies": {
"@elastic/elasticsearch": "7.13.0",
"@nestjs/common": "10.3.7",
"@nestjs/elasticsearch": "10.0.1",
"class-validator": "0.14.1",
"ramda": "0.29.1",
"reflect-metadata": "0.2.2"
},
"devDependencies": {
"@commitlint/cli": "19.2.1",
"@commitlint/config-conventional": "19.1.0",
"@faker-js/faker": "8.4.1",
"@nestjs/core": "10.3.7",
"@nestjs/platform-express": "10.3.7",
"@nestjs/testing": "10.3.7",
"@swc/core": "1.4.13",
"@swc/jest": "0.2.36",
"@types/jest": "29.5.12",
"@types/node": "20.12.7",
"@types/ramda": "0.29.12",
"@types/supertest": "6.0.2",
"@typescript-eslint/eslint-plugin": "7.6.0",
"@typescript-eslint/eslint-plugin-tslint": "7.0.2",
"@typescript-eslint/parser": "7.6.0",
"eslint": "8.57.0",
"eslint-config-codemask": "1.1.7",
"eslint-plugin-functional": "6.4.0",
"eslint-plugin-import": "2.29.1",
"eslint-plugin-jsdoc": "48.2.3",
"eslint-plugin-jsx-a11y": "6.8.0",
"eslint-plugin-nested-if": "1.0.0",
"eslint-plugin-no-else": "0.2.2",
"eslint-plugin-no-loops": "0.3.0",
"eslint-plugin-prefer-arrow": "1.2.3",
"eslint-plugin-react": "7.34.1",
"eslint-plugin-react-hooks": "4.6.0",
"expect-more-jest": "5.5.0",
"husky": "9.0.11",
"jest": "29.7.0",
"prettier": "3.2.5",
"rimraf": "5.0.5",
"rxjs": "7.8.1",
"semantic-release": "23.0.8",
"supertest": "6.3.4",
"ts-node": "10.9.2",
"tsconfig-paths": "4.2.0",
"tscpaths": "0.0.9",
"tslint": "6.1.3",
"typescript": "5.3.3",
"wait-on": "7.2.0"
},
"publishConfig": {
"@codemaskjs:registry": "https://registry.npmjs.org/",
"access": "public"
}
}
16 changes: 4 additions & 12 deletions src/lib/aggregations/get-top-hits.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,15 @@ describe('getTopHitsAggregation', () => {
const query = getTopHitsAggregation<HomeDocument>(1, {
from: 0,
includes: ['address', 'city', 'fullName'],
sort: [
{ address: { order: Order.ASC } }
]
sort: [{ address: { order: Order.ASC } }]
})

expect(query).toEqual({
// eslint-disable-next-line camelcase
top_hits: {
size: 1,
from: 0,
sort: [
{ address: { order: Order.ASC } }
],
sort: [{ address: { order: Order.ASC } }],
_source: {
includes: ['address', 'city', 'fullName']
}
Expand All @@ -31,19 +27,15 @@ describe('getTopHitsAggregation', () => {
const query = getTopHitsAggregation<HomeDocument>(1, {
from: 0,
includes: ['address', 'city', 'fullName'],
sort: [
{ 'address.keyword': { order: Order.ASC } }
]
sort: [{ 'address.keyword': { order: Order.ASC } }]
})

expect(query).toEqual({
// eslint-disable-next-line camelcase
top_hits: {
size: 1,
from: 0,
sort: [
{ 'address.keyword': { order: Order.ASC } }
],
sort: [{ 'address.keyword': { order: Order.ASC } }],
_source: {
includes: ['address', 'city', 'fullName']
}
Expand Down
44 changes: 22 additions & 22 deletions src/lib/elasticsearch/get-search-request-params.ts
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
import type { RequestParams } from '@elastic/elasticsearch'
import { ClassConstructor, Document } from 'lib/common'
import { AggregationsContainer } from 'lib/aggregations'
import { SearchRequestOptions, getSearchRequest } from 'lib/requests'
export const getSearchRequestParams = <TDocument extends Document, TAggregationsBody extends AggregationsContainer<TDocument>>(
document: ClassConstructor<TDocument>,
options?: SearchRequestOptions<TDocument, TAggregationsBody>
// eslint-disable-next-line @typescript-eslint/no-explicit-any
): RequestParams.Search<Record<string, any>> => {
const { index, size, from, query, aggregations } = getSearchRequest<TDocument, TAggregationsBody>(document, options)
return {
index,
size,
from,
body: {
query,
aggregations
}
}
}
import type { RequestParams } from '@elastic/elasticsearch'
import { ClassConstructor, Document } from 'lib/common'
import { AggregationsContainer } from 'lib/aggregations'
import { SearchRequestOptions, getSearchRequest } from 'lib/requests'

export const getSearchRequestParams = <TDocument extends Document, TAggregationsBody extends AggregationsContainer<TDocument>>(
document: ClassConstructor<TDocument>,
options?: SearchRequestOptions<TDocument, TAggregationsBody>
// eslint-disable-next-line @typescript-eslint/no-explicit-any
): RequestParams.Search<Record<string, any>> => {
const { index, size, from, query, aggregations } = getSearchRequest<TDocument, TAggregationsBody>(document, options)

return {
index,
size,
from,
body: {
query,
aggregations
}
}
}
2 changes: 1 addition & 1 deletion src/lib/elasticsearch/index.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export * from './get-search-request-params'
export * from './get-search-request-params'
11 changes: 6 additions & 5 deletions src/lib/transformers/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,12 @@ export type TransformedAggregation<
TDocument extends Document,
TName extends string | number | symbol,
TAggregations extends Aggregations<TDocument>
> = TAggregations['aggregations'] extends AggregationsContainer<TDocument>
? TransformAggregation<TDocument, TName, TAggregations, TAggregations['aggregations']>
: TAggregations['aggs'] extends AggregationsContainer<TDocument>
? TransformAggregation<TDocument, TName, TAggregations, TAggregations['aggs']>
: TransformAggregation<TDocument, TName, TAggregations, AggregationsContainer<TDocument>>
> =
TAggregations['aggregations'] extends AggregationsContainer<TDocument>
? TransformAggregation<TDocument, TName, TAggregations, TAggregations['aggregations']>
: TAggregations['aggs'] extends AggregationsContainer<TDocument>
? TransformAggregation<TDocument, TName, TAggregations, TAggregations['aggs']>
: TransformAggregation<TDocument, TName, TAggregations, AggregationsContainer<TDocument>>

export type TransformedAggregations<TDocument extends Document, TAggregationsBody extends AggregationsContainer<TDocument>> = {
[Name in keyof TAggregationsBody]: TransformedAggregation<TDocument, Name, TAggregationsBody[Name]>
Expand Down
Loading