EW-561 introducing some helper classes

src/modules/person/api/finde-persondatensatz-dto.ts

@@ -1,6 +1,7 @@
 import { AutoMap } from '@automapper/classes';
+import { PagedDto } from '../../../shared/paging/index.js';
 
-export class FindPersonDatensatzDTO {
+export class FindPersonDatensatzDTO extends PagedDto {
     @AutoMap()
     public referrer?: string;
 

src/modules/person/api/person-api.mapper.profile.ts

@@ -17,7 +17,7 @@ import { Gender, TrustLevel } from '../domain/person.enums.js';
 import { CreatePersonBodyParams } from './create-person.body.params.js';
 import { FindPersonDatensatzDTO } from './finde-persondatensatz-dto.js';
 import { PersonGender, PersonTrustLevel } from './person.enums.js';
-import { PersonenQueryParam, SichtfreigabeType } from './personen-query.param.js';
+import { PersonenQueryParams, SichtfreigabeType } from './personen-query.param.js';
 import { PersonenDatensatz } from './personendatensatz.js';
 
 export const personGenderToGenderConverter: Converter<PersonGender, Gender> = {
@@ -215,19 +215,19 @@ export class PersonApiMapperProfile extends AutomapperProfile {
             );
             createMap(
                 mapper,
-                PersonenQueryParam,
+                PersonenQueryParams,
                 FindPersonDatensatzDTO,
                 forMember(
                     (dest: FindPersonDatensatzDTO) => dest.vorname,
-                    mapFrom((src: PersonenQueryParam) => src.vorname),
+                    mapFrom((src: PersonenQueryParams) => src.vorname),
                 ),
                 forMember(
                     (dest: FindPersonDatensatzDTO) => dest.familienname,
-                    mapFrom((src: PersonenQueryParam) => src.familienname),
+                    mapFrom((src: PersonenQueryParams) => src.familienname),
                 ),
                 forMember(
                     (dest: FindPersonDatensatzDTO) => dest.referrer,
-                    mapFrom((src: PersonenQueryParam) => src.referrer),
+                    mapFrom((src: PersonenQueryParams) => src.referrer),
                 ),
             );
             createMap(

src/modules/person/api/person.controller.spec.ts

@@ -9,7 +9,7 @@ import { PersonUc } from './person.uc.js';
 import { PersonByIdParams } from './person-by-id.param.js';
 import { PersonResponse } from './person.response.js';
 import { HttpException } from '@nestjs/common';
-import { PersonenQueryParam } from './personen-query.param.js';
+import { PersonenQueryParams } from './personen-query.param.js';
 import { PersonBirthParams } from './person-birth.params.js';
 import { TrustLevel } from '../domain/person.enums.js';
 import { PersonenDatensatz } from './personendatensatz.js';
@@ -123,7 +123,7 @@ describe('PersonController', () => {
             lastName: faker.person.lastName(),
             firstName: faker.person.firstName(),
         };
-        const queryParams: PersonenQueryParam = {
+        const queryParams: PersonenQueryParams = {
             referrer: options.referrer,
             familienname: options.lastName,
             vorname: options.firstName,

src/modules/person/api/person.controller.ts

@@ -15,7 +15,7 @@ import { PersonUc } from '../api/person.uc.js';
 import { CreatePersonBodyParams } from './create-person.body.params.js';
 import { CreatePersonDto } from '../domain/create-person.dto.js';
 import { PersonByIdParams } from './person-by-id.param.js';
-import { PersonenQueryParam } from './personen-query.param.js';
+import { PersonenQueryParams } from './personen-query.param.js';
 import { FindPersonDatensatzDTO } from './finde-persondatensatz-dto.js';
 import { PersonenDatensatz } from './personendatensatz.js';
 import { Paged, PagedResponse } from '../../../shared/paging/index.js';
@@ -57,10 +57,10 @@ export class PersonController {
     @ApiUnauthorizedResponse({ description: 'Not authorized to get persons.' })
     @ApiForbiddenResponse({ description: 'Insufficient permissions to get persons.' })
     @ApiInternalServerErrorResponse({ description: 'Internal server error while getting all persons.' })
-    public async findPersons(@Query() queryParams: PersonenQueryParam): Promise<PagedResponse<PersonenDatensatz>> {
+    public async findPersons(@Query() queryParams: PersonenQueryParams): Promise<PagedResponse<PersonenDatensatz>> {
         const personDatensatzDTO: FindPersonDatensatzDTO = this.mapper.map(
             queryParams,
-            PersonenQueryParam,
+            PersonenQueryParams,
             FindPersonDatensatzDTO,
         );
         const persons: Paged<PersonenDatensatz> = await this.uc.findAll(personDatensatzDTO);

src/modules/person/api/person.uc.ts

@@ -54,7 +54,11 @@ export class PersonUc {
 
     public async findAll(personDto: FindPersonDatensatzDto): Promise<Paged<PersonenDatensatz>> {
         const personDo: PersonDo<false> = this.mapper.map(personDto, FindPersonDatensatzDto, PersonDo);
-        const result: Paged<PersonDo<true>> = await this.personService.findAllPersons(undefined, undefined, personDo);
+        const result: Paged<PersonDo<true>> = await this.personService.findAllPersons(
+            personDto.offset,
+            personDto.limit,
+            personDo,
+        );
 
         if (result.total === 0) {
             return {

src/modules/person/api/personen-query.param.ts

@@ -1,13 +1,14 @@
 import { ApiProperty } from '@nestjs/swagger';
 import { IsOptional, IsString } from 'class-validator';
 import { AutoMap } from '@automapper/classes';
+import { PagedQueryParams } from '../../../shared/paging/index.js';
 
 export enum SichtfreigabeType {
     JA = 'ja',
     NEIN = 'nein',
 }
 
-export class PersonenQueryParam {
+export class PersonenQueryParams extends PagedQueryParams {
     @AutoMap()
     @IsOptional()
     @IsString()
@@ -49,22 +50,4 @@ export class PersonenQueryParam {
         nullable: true,
     })
     public readonly sichtfreigabe: SichtfreigabeType = SichtfreigabeType.NEIN;*/
-
-    @AutoMap()
-    @IsOptional({})
-    @ApiProperty({
-        default: 0,
-        required: false,
-        nullable: false,
-    })
-    public readonly offset: number = 0;
-
-    @AutoMap()
-    @IsOptional({})
-    @ApiProperty({
-        default: 0,
-        required: false,
-        nullable: false,
-    })
-    public readonly limit: number = 100;
 }

src/shared/paging/index.ts

@@ -1,4 +1,5 @@
 export * from './global-pagination-headers.interceptor.js';
+export * from './paged.dto.js';
 export * from './paged.js';
 export * from './paged.query.params.js';
 export * from './paged.response.js';

src/shared/paging/paged.dto.ts

@@ -0,0 +1,9 @@
+import { AutoMap } from '@automapper/classes';
+
+export abstract class PagedDto {
+    @AutoMap()
+    public readonly offset?: number;
+
+    @AutoMap()
+    public readonly limit?: number;
+}

src/shared/paging/paged.query.params.ts

@@ -1,15 +1,21 @@
+import { AutoMap } from '@automapper/classes';
 import { ApiPropertyOptional } from '@nestjs/swagger';
+import { IsOptional } from 'class-validator';
 
 export abstract class PagedQueryParams {
+    @AutoMap()
+    @IsOptional()
     @ApiPropertyOptional({
         description: 'The offset of the paginated list.',
+        required: false,
     })
     public readonly offset?: number;
 
+    @AutoMap()
+    @IsOptional()
     @ApiPropertyOptional({
         description: 'The requested limit for the page size.',
+        required: false,
     })
     public readonly limit?: number;
 }
-
-

src/shared/persistence/index.ts

@@ -1,3 +1,2 @@
-// export * from './repo-base.js';
 export * from './scope-base.js';
 export * from './scope.enums.js';