feat(json-api-nestjs): add hooks support and enhance guards handling with afterCreateController hook and guards logic

- prepare for acl libs

Author: klerick

libs/json-api/json-api-nestjs/src/index.ts

@@ -18,6 +18,7 @@ export {
 export {
   JsonApiTransformerService,
   ErrorFormatService,
+  EntityParamMapService
 } from './lib/modules/mixin/service';
 export {
   MODULE_OPTIONS_TOKEN,

libs/json-api/json-api-nestjs/src/lib/modules/atomic-operation/service/execute.service.spec.ts

@@ -111,6 +111,7 @@ describe('ExecuteService', () => {
         {
           controller: { name: 'TestController' },
           methodName: 'someMethod',
+          module: {}
         },
       ] as unknown as ParamsForExecute[];
       const callback = vi.fn().mockReturnValue({ value: 'test' });
@@ -147,6 +148,7 @@ describe('ExecuteService', () => {
         {
           controller: { name: 'TestController' },
           methodName: 'someMethod',
+          module: {}
         },
       ] as unknown as ParamsForExecute[];
 
@@ -185,6 +187,7 @@ describe('ExecuteService', () => {
         {
           controller: { name: 'TestController' },
           methodName: 'someMethod',
+          module: {}
         },
       ] as unknown as ParamsForExecute[];
 

libs/json-api/json-api-nestjs/src/lib/modules/atomic-operation/service/execute.service.ts

@@ -6,6 +6,7 @@ import {
   PipeTransform,
   Type,
   InternalServerErrorException,
+  ForbiddenException,
 } from '@nestjs/common';
 import {
   INTERCEPTORS_METADATA,
@@ -24,6 +25,11 @@ import {
   InterceptorsConsumer,
   InterceptorsContextCreator,
 } from '@nestjs/core/interceptors';
+import {
+  FORBIDDEN_MESSAGE,
+  GuardsConsumer,
+  GuardsContextCreator,
+} from '@nestjs/core/guards';
 import { Controller } from '@nestjs/common/interfaces';
 import { lastValueFrom } from 'rxjs';
 import { AsyncLocalStorage } from 'async_hooks';
@@ -75,6 +81,7 @@ export class ExecuteService {
   @Inject(ErrorFormatService) private errorFormatService!: ErrorFormatService;
 
   private _interceptorsContextCreator!: InterceptorsContextCreator;
+  private _guardsContextCreator!: GuardsContextCreator;
 
   get interceptorsContextCreator() {
     if (!this._interceptorsContextCreator) {
@@ -87,7 +94,19 @@ export class ExecuteService {
     return this._interceptorsContextCreator;
   }
 
+  get guardsContextCreator() {
+    if (!this._guardsContextCreator) {
+      this._guardsContextCreator = new GuardsContextCreator(
+        this.moduleRef.container,
+        this.moduleRef.applicationConfig
+      );
+    }
+
+    return this._guardsContextCreator;
+  }
+
   private interceptorsConsumer = new InterceptorsConsumer();
+  private guardsConsumer = new GuardsConsumer();
 
   async run(params: ParamsForExecute[], tmpIds: (string | number)[]) {
     return this.runInTransaction(() => this.executeOperations(params, tmpIds));
@@ -127,6 +146,17 @@ export class ExecuteService {
             itemReplace[itemReplace.length - 1];
           }
         }
+        const guarFunction = this.getCanActivateFn(
+          controller,
+          controller[methodName],
+          currentParams.module
+        );
+
+        if (guarFunction) {
+          await guarFunction(
+            Object.values(this.asyncLocalStorage.getStore() || {})
+          );
+        }
 
         const interceptors = this.getInterceptorsArray(
           controller,
@@ -167,6 +197,32 @@ export class ExecuteService {
     return resultArray;
   }
 
+  private getCanActivateFn(
+    controller: Controller,
+    callback: (...arg: any) => any,
+    module: ParamsForExecute['module']
+  ) {
+    const guards = this.guardsContextCreator.create(
+      controller,
+      callback,
+      module.token
+    );
+
+    const canActivateFn = async (args: any[]) => {
+      const canActivate = await this.guardsConsumer.tryActivate(
+        guards,
+        args,
+        controller,
+        callback,
+        'http'
+      );
+      if (!canActivate) {
+        throw new ForbiddenException(FORBIDDEN_MESSAGE);
+      }
+    };
+    return guards.length ? canActivateFn : null;
+  }
+
   private getInterceptorsArray(
     controller: Controller,
     callback: (...arg: any) => any,
@@ -299,10 +355,14 @@ export class ExecuteService {
     const formatError = this.errorFormatService.formatError(e);
 
     if (formatError instanceof InternalServerErrorException) {
-      throw formatError
+      throw formatError;
     }
-    const response = formatError.getResponse()
-    if (typeof response === 'object' && 'message' in response && Array.isArray(response['message'])) {
+    const response = formatError.getResponse();
+    if (
+      typeof response === 'object' &&
+      'message' in response &&
+      Array.isArray(response['message'])
+    ) {
       response['message'] = response['message'].map((m: any) => {
         m['path'] = [KEY_MAIN_INPUT_SCHEMA, `${i}`, ...m['path']];
         return m;

libs/json-api/json-api-nestjs/src/lib/modules/mixin/mixin.module.ts

@@ -36,6 +36,8 @@ export class MixinModule {
 
     bindController(controllerClass, entity, moduleConfig);
 
+    mixinOptions.config.hooks.afterCreateController(controllerClass)
+
     const optionProvider = {
       provide: CONTROLLER_OPTIONS_TOKEN,
       useValue: moduleConfig,

libs/json-api/json-api-nestjs/src/lib/modules/mixin/swagger/method/index.ts

@@ -8,8 +8,6 @@ import { deleteRelationship } from './delete-relationship';
 import { postRelationship } from './post-relationship';
 import { patchRelationship } from './patch-relationship';
 
-import { OrmService } from '../../types';
-
 export const swaggerMethod = {
   getAll,
   getOne,
@@ -22,6 +20,3 @@ export const swaggerMethod = {
   patchRelationship,
 } as const;
 
-export type SwaggerMethod<E extends object> = {
-  [Key in keyof OrmService<E>]?: (typeof swaggerMethod)[Key];
-};

libs/json-api/json-api-nestjs/src/lib/modules/mixin/types/orm-service.type.ts

@@ -15,12 +15,23 @@ import {
 
 export interface OrmService<E extends object, IdKey extends string = 'id'> {
   getAll(
-    query: Query<E, IdKey>
+    query: Query<E, IdKey>,
   ): Promise<ResourceObject<E, 'array', null, IdKey>>;
+  getAll(
+    query: Query<E, IdKey>,
+    transformData?: boolean,
+    additionalQueryParams?: Record<string, unknown>
+  ): Promise<ResourceObject<E, 'array', null, IdKey> | { totalItems: number; items: E[] }>;
   getOne(
     id: number | string,
     query: QueryOne<E, IdKey>
   ): Promise<ResourceObject<E, 'object', null, IdKey>>;
+  getOne(
+    id: number | string,
+    query: QueryOne<E, IdKey>,
+    transformData?: boolean,
+    additionalQueryParams?: Record<string, unknown>
+  ): Promise<ResourceObject<E, 'object', null, IdKey> | E>;
   deleteOne(id: number | string): Promise<void>;
   patchOne(
     id: number | string,
@@ -51,4 +62,10 @@ export interface OrmService<E extends object, IdKey extends string = 'id'> {
     rel: Rel,
     input: PatchRelationshipData
   ): Promise<ResourceObjectRelationships<E, IdKey, Rel>>;
+
+  loadRelations(
+    relationships: PatchData<E, IdKey>['relationships'] | PostData<E, IdKey>['relationships'],
+  ): Promise<{
+    [K in RelationKeys<E>]: E[K];
+  }>;
 }

libs/json-api/json-api-nestjs/src/lib/modules/mixin/zod/zod-query-schema/filter.ts

@@ -89,7 +89,7 @@ function getZodRulesForField(type: TypeField = TypeField.string) {
       ...acum,
       [val]: zodRuleStringArray
         .refine(elementOfArrayMustBe(type), {
-          error: `String should be as ${type}`,
+          error: `String element of array should be as ${type}`,
         })
         .optional(),
     }),

libs/json-api/json-api-nestjs/src/lib/types/module-options.types.ts

@@ -1,4 +1,4 @@
-import { DynamicModule } from '@nestjs/common';
+import { DynamicModule, Type } from '@nestjs/common';
 import { NonEmptyArray } from 'zod-validation-error';
 import { AnyEntity, EntityClass } from '@klerick/json-api-nestjs-shared';
 import {
@@ -15,6 +15,9 @@ type ModuleCommonParams = {
   controllers?: NestController;
   providers?: NestProvider;
   imports?: NestImport;
+  hooks?: {
+    afterCreateController: (controller: Type<any>) => void;
+  }
 };
 
 type ModuleCommonOptions = {

libs/json-api/json-api-nestjs/src/lib/utils/module-helper.spec.ts

@@ -79,6 +79,9 @@ describe('module-helper', () => {
         providers: [],
         controllers: [],
         entities: [],
+        hooks: {
+          afterCreateController: result.hooks.afterCreateController,
+        },
         options: {
           operationUrl: undefined,
           requiredSelectField: false,

libs/json-api/json-api-nestjs/src/lib/utils/module-helper.ts

@@ -30,6 +30,9 @@ export function prepareConfig<OrmParams>(
       debug: !!options['debug'],
       pipeForId: options['pipeForId'] || ParseIntPipe,
       allowSetId: !!options['allowSetId']
+    },
+    hooks: {
+      afterCreateController: moduleParams['hooks'] && moduleParams['hooks']['afterCreateController'] || (() => void 0)
     }
   };
 }