@punks/backend-entity-manager 0.0.21 → 0.0.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1 +1 @@
|
|
|
1
|
-
export { EntitiesSearchResultsPaging, EntitiesSearchResults } from "./search";
|
|
1
|
+
export { IEntitiesSearchResultsPaging as EntitiesSearchResultsPaging, IEntitiesSearchResults as EntitiesSearchResults, } from "./search";
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { SortingType } from "../abstractions/common";
|
|
2
2
|
import { IEntitySearchParameters } from "../abstractions/searchParameters";
|
|
3
|
-
export
|
|
3
|
+
export interface IEntitiesSearchResultsPaging<TCursor> {
|
|
4
4
|
pageIndex: number;
|
|
5
5
|
pageSize: number;
|
|
6
6
|
totPageItems: number;
|
|
@@ -9,10 +9,10 @@ export type EntitiesSearchResultsPaging<TCursor> = {
|
|
|
9
9
|
nextPageCursor?: TCursor;
|
|
10
10
|
currentPageCursor?: TCursor;
|
|
11
11
|
prevPageCursor?: TCursor;
|
|
12
|
-
}
|
|
13
|
-
export
|
|
12
|
+
}
|
|
13
|
+
export interface IEntitiesSearchResults<TSearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TResult, TSorting extends SortingType, TCursor, TFacets> {
|
|
14
14
|
request: TSearchParameters;
|
|
15
15
|
items: TResult[];
|
|
16
16
|
facets?: TFacets;
|
|
17
|
-
paging?:
|
|
18
|
-
}
|
|
17
|
+
paging?: IEntitiesSearchResultsPaging<TCursor>;
|
|
18
|
+
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export { EntitiesSearchResultsPaging, EntitiesSearchResults } from "./search";
|
|
1
|
+
export { IEntitiesSearchResultsPaging as EntitiesSearchResultsPaging, IEntitiesSearchResults as EntitiesSearchResults, } from "./search";
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { SortingType } from "../abstractions/common";
|
|
2
2
|
import { IEntitySearchParameters } from "../abstractions/searchParameters";
|
|
3
|
-
export
|
|
3
|
+
export interface IEntitiesSearchResultsPaging<TCursor> {
|
|
4
4
|
pageIndex: number;
|
|
5
5
|
pageSize: number;
|
|
6
6
|
totPageItems: number;
|
|
@@ -9,10 +9,10 @@ export type EntitiesSearchResultsPaging<TCursor> = {
|
|
|
9
9
|
nextPageCursor?: TCursor;
|
|
10
10
|
currentPageCursor?: TCursor;
|
|
11
11
|
prevPageCursor?: TCursor;
|
|
12
|
-
}
|
|
13
|
-
export
|
|
12
|
+
}
|
|
13
|
+
export interface IEntitiesSearchResults<TSearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TResult, TSorting extends SortingType, TCursor, TFacets> {
|
|
14
14
|
request: TSearchParameters;
|
|
15
15
|
items: TResult[];
|
|
16
16
|
facets?: TFacets;
|
|
17
|
-
paging?:
|
|
18
|
-
}
|
|
17
|
+
paging?: IEntitiesSearchResultsPaging<TCursor>;
|
|
18
|
+
}
|
package/dist/index.d.ts
CHANGED
|
@@ -45,7 +45,7 @@ declare enum SortDirection {
|
|
|
45
45
|
Desc = "desc"
|
|
46
46
|
}
|
|
47
47
|
|
|
48
|
-
|
|
48
|
+
interface IEntitiesSearchResultsPaging<TCursor> {
|
|
49
49
|
pageIndex: number;
|
|
50
50
|
pageSize: number;
|
|
51
51
|
totPageItems: number;
|
|
@@ -54,13 +54,13 @@ type EntitiesSearchResultsPaging<TCursor> = {
|
|
|
54
54
|
nextPageCursor?: TCursor;
|
|
55
55
|
currentPageCursor?: TCursor;
|
|
56
56
|
prevPageCursor?: TCursor;
|
|
57
|
-
}
|
|
58
|
-
|
|
57
|
+
}
|
|
58
|
+
interface IEntitiesSearchResults<TSearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TResult, TSorting extends SortingType, TCursor, TFacets> {
|
|
59
59
|
request: TSearchParameters;
|
|
60
60
|
items: TResult[];
|
|
61
61
|
facets?: TFacets;
|
|
62
|
-
paging?:
|
|
63
|
-
}
|
|
62
|
+
paging?: IEntitiesSearchResultsPaging<TCursor>;
|
|
63
|
+
}
|
|
64
64
|
|
|
65
65
|
interface IEntityCreateAction<TEntity, TEntityCreateDto, TEntityDto> {
|
|
66
66
|
execute(input: TEntityCreateDto): Promise<TEntityDto>;
|
|
@@ -78,7 +78,7 @@ interface IEntityUpsertAction<TEntity, TEntityId, TEntityUpdateDto, TEntityDto>
|
|
|
78
78
|
execute(id: TEntityId, input: TEntityUpdateDto): Promise<TEntityDto>;
|
|
79
79
|
}
|
|
80
80
|
interface IEntitiesSearchAction<TEntity, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TEntityListItemDto, TSorting extends SortingType, TCursor, TFacets> {
|
|
81
|
-
execute(request: TEntitySearchParameters): Promise<
|
|
81
|
+
execute(request: TEntitySearchParameters): Promise<IEntitiesSearchResults<TEntitySearchParameters, TEntityListItemDto, TSorting, TCursor, TFacets>>;
|
|
82
82
|
}
|
|
83
83
|
interface IEntityActions<TEntity, TEntityId, TEntityCreateDto, TEntityUpdateDto, TEntityDto, TEntityListItemDto, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor, TFacets> {
|
|
84
84
|
get(): IEntityGetAction<TEntity, TEntityId, TEntityDto>;
|
|
@@ -209,13 +209,13 @@ interface IEventEmitter {
|
|
|
209
209
|
}
|
|
210
210
|
|
|
211
211
|
interface IEntitiesSearchQuery<TEntity, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor, TFacets> {
|
|
212
|
-
execute(request: TEntitySearchParameters): Promise<
|
|
212
|
+
execute(request: TEntitySearchParameters): Promise<IEntitiesSearchResults<TEntitySearchParameters, TEntity, TSorting, TCursor, TFacets>>;
|
|
213
213
|
}
|
|
214
214
|
interface IEntityGetQuery<TEntity, TEntityId> {
|
|
215
215
|
execute(id: TEntityId): Promise<TEntity | undefined>;
|
|
216
216
|
}
|
|
217
217
|
interface IEntitiesQueryBuilder<TEntity, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor, TFacets> {
|
|
218
|
-
search(request: TEntitySearchParameters): Promise<
|
|
218
|
+
search(request: TEntitySearchParameters): Promise<IEntitiesSearchResults<TEntitySearchParameters, TEntity, TSorting, TCursor, TFacets>>;
|
|
219
219
|
}
|
|
220
220
|
|
|
221
221
|
interface IEntityManager<TEntity, TEntityId, TEntityCreateData, TEntityUpdateData, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor, TFacets> {
|
|
@@ -608,12 +608,12 @@ declare abstract class NestEntityManager<TEntity, TEntityId, TEntityCreateData,
|
|
|
608
608
|
}
|
|
609
609
|
|
|
610
610
|
declare abstract class QueryBuilderBase<TEntity, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor, TFacets> implements IEntitiesQueryBuilder<TEntity, TEntitySearchParameters, TSorting, TCursor, TFacets> {
|
|
611
|
-
abstract search(request: TEntitySearchParameters): Promise<
|
|
611
|
+
abstract search(request: TEntitySearchParameters): Promise<IEntitiesSearchResults<TEntitySearchParameters, TEntity, TSorting, TCursor, TFacets>>;
|
|
612
612
|
protected getIndexBasedPagingResult({ paging, totResults, currentPageResults, }: {
|
|
613
613
|
paging?: ISearchRequestPaging<number>;
|
|
614
614
|
totResults: number;
|
|
615
615
|
currentPageResults: number;
|
|
616
|
-
}):
|
|
616
|
+
}): IEntitiesSearchResultsPaging<number> | undefined;
|
|
617
617
|
}
|
|
618
618
|
|
|
619
619
|
type UpdateCriteria<TEntity extends ObjectLiteral> = string | string[] | number | number[] | Date | Date[] | ObjectId | ObjectId[] | FindOptionsWhere<TEntity>;
|
|
@@ -641,7 +641,7 @@ declare abstract class TypeOrmQueryBuilder<TEntity extends ObjectLiteral, TEntit
|
|
|
641
641
|
private readonly services;
|
|
642
642
|
private repository;
|
|
643
643
|
constructor(services: EntityServiceLocator<TEntity, unknown>);
|
|
644
|
-
search(request: TEntitySearchParameters): Promise<
|
|
644
|
+
search(request: TEntitySearchParameters): Promise<IEntitiesSearchResults<TEntitySearchParameters, TEntity, TSorting, number, TFacets>>;
|
|
645
645
|
protected findPagedQueryResults(request: TEntitySearchParameters): Promise<TEntity[]>;
|
|
646
646
|
protected getRelationsToLoad(request: TEntitySearchParameters): FindOptionsRelations<TEntity> | undefined;
|
|
647
647
|
protected buildPagingParameters(request: TEntitySearchParameters): {
|