Merge pull request #47 from dxfrontier/feature/various

.eslintignore

@@ -1,3 +1,8 @@
 # Ignore artifacts
 dist
-test
+
+test/e2e
+test/integration
+test/unit
+test/util
+test/bookshop/@cds-models

lib/types/types.ts

@@ -44,7 +44,7 @@ export type NextMiddleware = () => Promise<unknown>;
  * Use `NextEvent` type to annotate the `next` parameter of the implementation of the `ON` events.
  * @example "@Next() next: NextEvent"
  */
-export type NextEvent = (req?: Request) => void;
+export type NextEvent = (req?: Request) => Function;
 
 export type MiddlewareImpl = {
   use: (req: Request, next: NextMiddleware) => Promise<unknown>;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxfrontier/cds-ts-dispatcher",
-  "version": "2.0.8",
+  "version": "2.0.9",
   "description": "The goal of CDS-TS-Dispatcher is to significantly reduce the boilerplate code required to implement TS handlers provided by the SAP CAP framework.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

test/bookshop/srv/controller/admin-service/handler/PromotionsHandler.ts

@@ -7,33 +7,33 @@ import {
   Inject,
   Req,
   Result,
+  Service,
   SRV,
+  TypedRequest,
 } from '../../../../../../lib';
 import { Promotion } from '../../../../@cds-models/AdminService';
 
-import type { TypedRequest, Service } from '../../../../../../lib';
-
 @EntityHandler(Promotion)
 class PromotionHandler {
   @Inject(SRV) private readonly srv: Service;
 
   @AfterNewDraft()
-  public async afterNewDraft(@Result() result: Promotion, @Req() req: TypedRequest<Promotion>) {
+  public async afterNewDraft(@Result() result: Promotion, @Req() req: TypedRequest<Promotion>): Promise<void> {
     req.notify(201, 'After new draft executed');
   }
 
   @AfterSaveDraft()
-  public async afterSaveDraft(@Result() result: Promotion, @Req() req: TypedRequest<Promotion>) {
+  public async afterSaveDraft(@Result() result: Promotion, @Req() req: TypedRequest<Promotion>): Promise<void> {
     req.notify(201, 'After save draft executed');
   }
 
   @AfterEditDraft()
-  public async afterEditDraft(@Result() result: Promotion, @Req() req: TypedRequest<Promotion>) {
+  public async afterEditDraft(@Result() result: Promotion, @Req() req: TypedRequest<Promotion>): Promise<void> {
     req.notify(201, 'After edit draft executed');
   }
 
   @AfterDeleteDraft()
-  public async afterDeleteDraft(@Result() deleted: boolean, @Req() req: TypedRequest<Promotion>) {
+  public async afterDeleteDraft(@Result() deleted: boolean, @Req() req: TypedRequest<Promotion>): Promise<void> {
     // ...
   }
 }

test/bookshop/srv/controller/admin-service/handler/UserActivityLogHandler.ts

@@ -6,33 +6,33 @@ import {
   EntityHandler,
   Inject,
   Req,
+  Service,
   SRV,
+  TypedRequest,
 } from '../../../../../../lib';
 import { UserActivityLog } from '../../../../@cds-models/AdminService';
 
-import type { Service, TypedRequest } from '../../../../../../lib';
-
 @EntityHandler(UserActivityLog)
 class UserActivityLogHandler {
   @Inject(SRV) private readonly srv: Service;
 
   @BeforeNewDraft()
-  public async beforeNewDraft(@Req() req: TypedRequest<UserActivityLog>) {
+  public async beforeNewDraft(@Req() req: TypedRequest<UserActivityLog>): Promise<void> {
     req.notify(201, 'Before new draft executed');
   }
 
   @BeforeSaveDraft()
-  public async beforeSaveDraft(@Req() req: TypedRequest<UserActivityLog>) {
+  public async beforeSaveDraft(@Req() req: TypedRequest<UserActivityLog>): Promise<void> {
     req.notify(201, 'Before save draft executed');
   }
 
   @BeforeEditDraft()
-  public async beforeEditDraft(@Req() req: TypedRequest<UserActivityLog>) {
+  public async beforeEditDraft(@Req() req: TypedRequest<UserActivityLog>): Promise<void> {
     req.notify(201, 'Before edit draft executed');
   }
 
   @BeforeDeleteDraft()
-  public async beforeDeleteDraft(@Req() req: TypedRequest<UserActivityLog>) {
+  public async beforeDeleteDraft(@Req() req: TypedRequest<UserActivityLog>): Promise<void> {
     // ...
   }
 }

test/bookshop/srv/controller/cat-service/handler/BookEventsHandler.ts

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/explicit-function-return-type */
+/* eslint-disable @typescript-eslint/no-confusing-void-expression */
 import {
   AfterRead,
   AfterReadDraft,
@@ -54,7 +56,7 @@ class BookEventsHandler {
     @Results() results: BookEvent[],
     @Req() req: Request,
     @SingleInstanceSwitch() isSingleInstance: boolean,
-  ) {
+  ): Promise<void> {
     this.bookEventsService.handleSingleInstance(req, results, isSingleInstance);
   }
 }

test/bookshop/srv/controller/cat-service/handler/BookFormatsHandler.ts

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/no-confusing-void-expression */
+/* eslint-disable @typescript-eslint/explicit-function-return-type */
 import {
   AfterRead,
   BeforeCreate,
@@ -24,13 +26,13 @@ class BookFormatsHandler {
 
   @BeforeCreate()
   @FieldsFormatter<BookFormat>({ action: 'blacklist', charsToRemove: 'le' }, 'format')
-  public async beforeCreate(@Req() req: TypedRequest<BookFormat>) {
+  public async beforeCreate(@Req() req: TypedRequest<BookFormat>): Promise<void> {
     // ...
   }
 
   @BeforeUpdate()
   @FieldsFormatter<BookFormat>({ action: 'truncate', options: { length: 7 } }, 'format')
-  public async beforeUpdate(@Req() req: TypedRequest<BookFormat>) {
+  public async beforeUpdate(@Req() req: TypedRequest<BookFormat>): Promise<void> {
     // ...
   }
 

test/bookshop/srv/controller/cat-service/handler/BookHandler.ts

@@ -35,13 +35,13 @@ class BookHandler {
   @Inject(BookService) private readonly bookService: BookService;
 
   @AfterCreate()
-  private async afterCreate(@Result() result: Book, @Req() req: Request) {
+  private async afterCreate(@Result() result: Book, @Req() req: Request): Promise<void> {
     this.bookService.validateData(result, req);
   }
 
   @BeforeRead()
   @Use(MiddlewareMethodBeforeRead)
-  private async beforeRead(@Req() req: TypedRequest<Book>) {
+  private async beforeRead(@Req() req: TypedRequest<Book>): Promise<void> {
     this.bookService.showConsoleLog();
   }
 
@@ -55,17 +55,17 @@ class BookHandler {
     @IsPresent('SELECT', 'columns') hasColumns: boolean,
     @IsRole('Developer', 'AnotherRole') role: boolean,
     @GetRequest('locale') locale: Request['locale'],
-  ) {
-    this.bookService.manageAfterReadMethods({ req, results, singleInstance });
+  ): Promise<void> {
+    await this.bookService.manageAfterReadMethods({ req, results, singleInstance });
   }
 
   @AfterUpdate()
-  private async afterUpdate(@Result() result: Book, @Req() req: TypedRequest<Book>) {
-    this.bookService.addDefaultTitleText(result, req);
+  private async afterUpdate(@Result() result: Book, @Req() req: TypedRequest<Book>): Promise<void> {
+    await this.bookService.addDefaultTitleText(result, req);
   }
 
   @AfterDelete()
-  private async afterDelete(@Result() deleted: boolean, @Req() req: Request) {
+  private async afterDelete(@Result() deleted: boolean, @Req() req: Request): Promise<void> {
     this.bookService.notifyItemDeleted(req, deleted);
   }
 }

test/bookshop/srv/controller/cat-service/handler/BookOrdersHandler.ts

@@ -30,13 +30,13 @@ class BookOrdersHandler {
   @Inject(BookOrdersService) private readonly bookOrdersService: BookOrdersService;
 
   @AfterCreate()
-  private async afterCreate(@Results() result: BookOrder, @Req() req: Request) {
+  private async afterCreate(@Results() result: BookOrder, @Req() req: Request): Promise<void> {
     this.bookService.validateData(result, req);
   }
 
   @BeforeRead()
   @Use(MiddlewareMethodBeforeRead) // THIS IS OK
-  private async beforeRead(req: Request) {
+  private async beforeRead(req: Request): Promise<void> {
     this.bookOrdersService.showBeforeReadNotify();
   }
 
@@ -46,7 +46,7 @@ class BookOrdersHandler {
     @Results() results: BookOrder[],
     @Req() req: Request,
     @SingleInstanceSwitch() isSingleInstance: boolean,
-  ) {
+  ): Promise<void> {
     // Method implementation
   }
 }

test/bookshop/srv/controller/cat-service/handler/BookRecommendationsHandler.ts

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/explicit-function-return-type */
+/* eslint-disable @typescript-eslint/no-confusing-void-expression */
 import {
   BeforeCreate,
   BeforeUpdate,
@@ -35,13 +37,13 @@ class BookRecommendationsHandler {
 
   @OnCreate()
   @Validate<BookRecommendation>({ action: 'isAlphanumeric' }, 'book_ID')
-  public async create(@Req() req: TypedRequest<BookRecommendation>, @Next() next: NextEvent) {
+  public async create(@Req() req: TypedRequest<BookRecommendation>, @Next() next: NextEvent): Promise<Function> {
     return next();
   }
 
   @OnUpdate()
   @Validate<BookRecommendation>({ action: 'isLength', options: { min: 5 } }, 'comment')
-  public async update(@Req() req: TypedRequest<BookRecommendation>, @Next() next: NextEvent) {
+  public async update(@Req() req: TypedRequest<BookRecommendation>, @Next() next: NextEvent): Promise<Function> {
     return next();
   }
 }

test/bookshop/srv/controller/cat-service/handler/BookSalesHandler.ts

@@ -5,7 +5,6 @@ import {
   EntityHandler,
   ExecutionAllowedForRole,
   GetQuery,
-  GetQueryType,
   GetRequest,
   Inject,
   IsColumnSupplied,
@@ -21,6 +20,8 @@ import {
 } from '../../../../../../lib';
 import BookSalesService from '../../../service/BookSalesService';
 
+import type { GetQueryType } from '../../../../../../lib';
+
 @EntityHandler(BookSale)
 class BookSalesHandler {
   @Inject(SRV) private readonly srv: Service;
@@ -49,7 +50,7 @@ class BookSalesHandler {
     @SingleInstanceSwitch() isSingleInstance: boolean,
 
     @Jwt() token: string | undefined,
-  ) {
+  ): Promise<void> {
     this.bookSalesService.showAfterReadNotifies({
       req,
       hasRoles,

test/bookshop/srv/controller/cat-service/handler/BookStatsHandler.ts

@@ -1,25 +1,29 @@
+/* eslint-disable @typescript-eslint/explicit-function-return-type */
+/* eslint-disable @typescript-eslint/no-confusing-void-expression */
 import {
-  AfterRead,
+  ActionRequest,
+  ActionReturn,
   EntityHandler,
   Inject,
   Next,
+  NextEvent,
   OnBoundAction,
   OnBoundFunction,
   OnCreate,
   OnDelete,
   OnRead,
   OnUpdate,
   Req,
-  Results,
+  Request,
+  Service,
   SingleInstanceSwitch,
   SRV,
+  TypedRequest,
 } from '../../../../../../lib';
 import { BookStat } from '../../../../@cds-models/CatalogService';
 import AuthorService from '../../../service/AuthorService';
 import BookStatsService from '../../../service/BookStatsService';
 
-import type { TypedRequest, Service, Request, ActionRequest, ActionReturn, NextEvent } from '../../../../../../lib';
-
 @EntityHandler(BookStat)
 class BookStatsHandler {
   @Inject(SRV) private readonly srv: Service;

test/bookshop/srv/controller/cat-service/handler/PublishersHandler.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/explicit-function-return-type */
 import { Publisher } from '#cds-models/CatalogService';
 
 import {

test/bookshop/srv/controller/cat-service/handler/ReviewHandler.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/explicit-function-return-type */
 import {
   BeforeCreate,
   BeforeDelete,

test/bookshop/srv/controller/cat-service/handler/UnboundActions.ts

@@ -19,7 +19,6 @@ import {
   Use,
   Validate,
 } from '../../../../../../lib';
-import { ExposeFields } from '../../../../../../lib/types/validator';
 import {
   changeBookProperties,
   OrderedBook,
@@ -29,6 +28,8 @@ import {
 import { MiddlewareEntity1 } from '../../../middleware/MiddlewareEntity1';
 import { MiddlewareEntity2 } from '../../../middleware/MiddlewareEntity2';
 
+import type { ExposeFields } from '../../../../../../lib/types/validator';
+
 @UnboundActions()
 @Use(MiddlewareEntity1, MiddlewareEntity2)
 class UnboundActionsHandler {
@@ -69,6 +70,7 @@ class UnboundActionsHandler {
   }
 
   @OnEvent(OrderedBook)
+  // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
   public async orderedBook(req: TypedRequest<OrderedBook>) {
     if (req.event !== 'OrderedBook') {
       req.reject(400, 'Not OrderedBook: check @OnEvent decorator');

test/bookshop/srv/middleware/MiddlewareAfterRead1.ts

@@ -1,11 +1,11 @@
-import { Book } from '#cds-models/CatalogService';
+import type { Book } from '#cds-models/CatalogService';
 
-import { TypedRequest } from '@sap/cds';
+import type { TypedRequest } from '@sap/cds';
 
-import { MiddlewareImpl, NextMiddleware } from '../../../../lib/types/types';
+import type { MiddlewareImpl, NextMiddleware } from '../../../../lib/types/types';
 
 export class MiddlewareMethodAfterRead1 implements MiddlewareImpl {
-  public async use(req: TypedRequest<Book>, next: NextMiddleware) {
+  public async use(req: TypedRequest<Book>, next: NextMiddleware): Promise<void> {
     console.log('Middleware 1: @AfterRead');
 
     await next();

test/bookshop/srv/middleware/MiddlewareAfterRead2.ts

@@ -1,11 +1,11 @@
-import { Book } from '#cds-models/CatalogService';
+import type { Book } from '#cds-models/CatalogService';
 
-import { TypedRequest } from '@sap/cds';
+import type { TypedRequest } from '@sap/cds';
 
-import { MiddlewareImpl, NextMiddleware } from '../../../../lib/types/types';
+import type { MiddlewareImpl, NextMiddleware } from '../../../../lib/types/types';
 
 export class MiddlewareMethodAfterRead2 implements MiddlewareImpl {
-  public async use(req: TypedRequest<Book>, next: NextMiddleware) {
+  public async use(req: TypedRequest<Book>, next: NextMiddleware): Promise<void> {
     console.log('Middleware 2: @AfterRead');
 
     req.notify('MiddlewareAfterRead2');

test/bookshop/srv/middleware/MiddlewareBeforeRead.ts

@@ -1,11 +1,11 @@
-import { Book } from '#cds-models/CatalogService';
+import type { Book } from '#cds-models/CatalogService';
 
-import { TypedRequest } from '@sap/cds';
+import type { TypedRequest } from '@sap/cds';
 
-import { MiddlewareImpl, NextMiddleware } from '../../../../lib/types/types';
+import type { MiddlewareImpl, NextMiddleware } from '../../../../lib/types/types';
 
 export class MiddlewareMethodBeforeRead implements MiddlewareImpl {
-  public async use(req: TypedRequest<Book>, next: NextMiddleware) {
+  public async use(req: TypedRequest<Book>, next: NextMiddleware): Promise<void> {
     console.log('Middleware 1: @BeforeRead');
     await next();
   }