feat(json-api-nestjs): add allowSetId option for enhanced control over entity ID assignment during POST operations

Author: klerick

libs/json-api/json-api-nestjs/src/lib/modules/mixin/pipe/post-input/post-input.pipe.spec.ts

@@ -7,14 +7,17 @@ import {
 
 import { PostInputPipe } from './post-input.pipe';
 import { PostData, ZodPost } from '../../zod';
-import { JSONValue } from '../../types';
-import { ZOD_POST_SCHEMA } from '../../../../constants';
+import { EntityControllerParam, JSONValue } from '../../types';
+import {
+  CONTROLLER_OPTIONS_TOKEN,
+  ZOD_POST_SCHEMA,
+} from '../../../../constants';
 import { Users } from '../../../../utils/___test___/test-classes.helper';
 
 describe('PostInputPipe', () => {
   let pipe: PostInputPipe<Users>;
   let mockSchema: ZodPost<Users, 'id'>;
-
+  let controllerOptions: EntityControllerParam;
   beforeEach(async () => {
     const module: TestingModule = await Test.createTestingModule({
       providers: [
@@ -25,17 +28,24 @@ describe('PostInputPipe', () => {
             parse: vi.fn(),
           },
         },
+        {
+          provide: CONTROLLER_OPTIONS_TOKEN,
+          useValue: {
+            allowSetId: false,
+          },
+        }
       ],
     }).compile();
 
     pipe = module.get<PostInputPipe<Users>>(PostInputPipe);
     mockSchema = module.get<ZodPost<Users, 'id'>>(ZOD_POST_SCHEMA);
+    controllerOptions = module.get<EntityControllerParam>(CONTROLLER_OPTIONS_TOKEN);
   });
 
   it('should transform JSONValue to PostData on success', () => {
     const input: JSONValue = { key: 'value' } as any;
     const expectedData: PostData<Users, 'id'> = { id: 1, key: 'value' } as any;
-
+    controllerOptions.allowSetId = false;
     vi
       .spyOn(mockSchema, 'parse')
       .mockReturnValue({ data: expectedData } as any);
@@ -44,6 +54,18 @@ describe('PostInputPipe', () => {
     expect(mockSchema.parse).toHaveBeenCalledWith(input);
   });
 
+  it('should transform JSONValue to PostData on success and delete id', () => {
+    const input: JSONValue = { key: 'value' } as any;
+    const expectedData: PostData<Users, 'id'> = { id: 1, key: 'value' } as any;
+
+    vi
+      .spyOn(mockSchema, 'parse')
+      .mockReturnValue({ data: expectedData } as any);
+
+    expect(pipe.transform(input)).toEqual({key: 'value'});
+    expect(mockSchema.parse).toHaveBeenCalledWith(input);
+  });
+
   it('should throw BadRequestException if ZodError occurs', () => {
     const input: JSONValue = { key: 'value' };
 

libs/json-api/json-api-nestjs/src/lib/modules/mixin/pipe/post-input/post-input.pipe.ts

@@ -7,16 +7,24 @@ import {
 import { ZodError } from 'zod';
 
 import { PostData, ZodPost } from '../../zod';
-import { ZOD_POST_SCHEMA } from '../../../../constants';
-import { JSONValue } from '../../types';
+import {
+  CONTROLLER_OPTIONS_TOKEN,
+  ZOD_POST_SCHEMA,
+} from '../../../../constants';
+import { EntityControllerParam, JSONValue } from '../../types';
 
 export class PostInputPipe<E extends object>
   implements PipeTransform<JSONValue, PostData<E, 'id'>>
 {
   @Inject(ZOD_POST_SCHEMA) private zodInputPostSchema!: ZodPost<E, 'id'>;
+  @Inject(CONTROLLER_OPTIONS_TOKEN) private controllerParams!: EntityControllerParam;
   transform(value: JSONValue): PostData<E, 'id'> {
     try {
-      return this.zodInputPostSchema.parse(value)['data'] as PostData<E, 'id'>;
+      const result = this.zodInputPostSchema.parse(value)['data'] as PostData<E, 'id'>;
+      if (!this.controllerParams.allowSetId) {
+        delete result.id;
+      }
+      return result;
     } catch (e) {
       if (e instanceof ZodError) {
         throw new BadRequestException(e.issues);

libs/json-api/json-api-nestjs/src/lib/modules/mixin/types/decorator-options.type.ts

@@ -5,6 +5,7 @@ import { PrepareParams } from '../../../types';
 type ControllerOptions = {
   allowMethod: Array<MethodName>;
   overrideRoute: string;
+  allowSetId: boolean
 };
 
 export type DecoratorOptions<OrmParams = NonNullable<unknown>> = Partial<

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

@@ -22,6 +22,7 @@ type ModuleCommonOptions = {
   debug?: boolean;
   pipeForId?: PipeMixin;
   operationUrl?: string;
+  allowSetId?: boolean
 };
 
 type ModuleOptionsParams<OrmParams = NonNullable<unknown>> = IfEquals<

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

@@ -83,6 +83,7 @@ describe('module-helper', () => {
           operationUrl: undefined,
           requiredSelectField: false,
           debug: false,
+          allowSetId: false,
           pipeForId: ParseIntPipe,
         },
       });
@@ -115,6 +116,7 @@ describe('module-helper', () => {
       const result = prepareConfig(moduleParams);
 
       expect(result.options).toEqual({
+        allowSetId: false,
         operationUrl: 'http://example.com',
         requiredSelectField: false,
         debug: true,
@@ -179,6 +181,7 @@ describe('module-helper', () => {
       expect(result.entities).toBe(entities);
       expect(result).toHaveProperty('options');
       expect(result.options).toEqual({
+        allowSetId: false,
         operationUrl: undefined,
         requiredSelectField: false,
         debug: false,

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

@@ -29,7 +29,8 @@ export function prepareConfig<OrmParams>(
       requiredSelectField: !!options['requiredSelectField'],
       debug: !!options['debug'],
       pipeForId: options['pipeForId'] || ParseIntPipe,
-    },
+      allowSetId: !!options['allowSetId']
+    }
   };
 }