fix(json-api-nestjs): replace deprecated faker methods, enhance zod schemas with transformations and update constants with METHOD_NAME. change name for method function

Author: klerick

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

@@ -32,6 +32,7 @@ export {
   DEFAULT_PAGE_SIZE,
   DEFAULT_QUERY_PAGE,
   CURRENT_ENTITY,
+  METHOD_NAME
 } from './lib/constants';
 export {
   OrmService,
@@ -41,6 +42,7 @@ export {
   FindOneRowEntity,
   RunInTransaction,
   EntityParamMap,
+  MethodName
 } from './lib/modules/mixin/types';
 export {
   PatchData,

libs/json-api/json-api-nestjs/src/lib/constants/constants.ts

@@ -1,3 +1,5 @@
+import { MethodName } from '../modules/mixin/types';
+
 export const JSON_API_CONTROLLER_POSTFIX = 'JsonApiController';
 export const JSON_API_MODULE_POSTFIX = 'JsonApiModule';
 export const DEFAULT_CONNECTION_NAME = 'default';
@@ -8,3 +10,16 @@ export const DESC = 'DESC';
 export const ASC = 'ASC';
 
 export const SORT_TYPE = [DESC, ASC] as const;
+export const METHOD_NAME: {
+  [P in MethodName]: P;
+} = {
+  getAll: 'getAll',
+  getOne: 'getOne',
+  deleteOne: 'deleteOne',
+  deleteRelationship: 'deleteRelationship',
+  postOne: 'postOne',
+  getRelationship: 'getRelationship',
+  patchOne: 'patchOne',
+  patchRelationship: 'patchRelationship',
+  postRelationship: 'postRelationship',
+};

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

@@ -2,7 +2,11 @@ import { Body, Param, Query, RequestMethod } from '@nestjs/common';
 
 import { BindingsConfig } from '../types';
 import { JsonBaseController } from '../controllers/json-base.controller';
-import { PARAMS_RELATION_NAME, PARAMS_RESOURCE_ID } from '../../../constants';
+import {
+  METHOD_NAME,
+  PARAMS_RELATION_NAME,
+  PARAMS_RESOURCE_ID,
+} from '../../../constants';
 
 import {
   queryInputMixin,
@@ -19,7 +23,7 @@ import {
 } from '../pipe';
 
 const Bindings: BindingsConfig = {
-  getAll: {
+  [METHOD_NAME.getAll]: {
     method: RequestMethod.GET,
     name: 'getAll',
     path: '/',
@@ -36,7 +40,7 @@ const Bindings: BindingsConfig = {
       },
     ],
   },
-  getOne: {
+  [METHOD_NAME.getOne]: {
     method: RequestMethod.GET,
     name: 'getOne',
     path: `:${PARAMS_RESOURCE_ID}`,
@@ -58,7 +62,7 @@ const Bindings: BindingsConfig = {
       },
     ],
   },
-  deleteOne: {
+  [METHOD_NAME.deleteOne]: {
     method: RequestMethod.DELETE,
     name: 'deleteOne',
     path: `:${PARAMS_RESOURCE_ID}`,
@@ -71,7 +75,7 @@ const Bindings: BindingsConfig = {
       },
     ],
   },
-  postOne: {
+  [METHOD_NAME.postOne]: {
     method: RequestMethod.POST,
     name: 'postOne',
     path: '/',
@@ -83,7 +87,7 @@ const Bindings: BindingsConfig = {
       },
     ],
   },
-  patchOne: {
+  [METHOD_NAME.patchOne]: {
     method: RequestMethod.PATCH,
     name: 'patchOne',
     path: `:${PARAMS_RESOURCE_ID}`,
@@ -100,7 +104,7 @@ const Bindings: BindingsConfig = {
       },
     ],
   },
-  getRelationship: {
+  [METHOD_NAME.getRelationship]: {
     path: `:${PARAMS_RESOURCE_ID}/relationships/:${PARAMS_RELATION_NAME}`,
     name: 'getRelationship',
     method: RequestMethod.GET,
@@ -118,7 +122,7 @@ const Bindings: BindingsConfig = {
       },
     ],
   },
-  postRelationship: {
+  [METHOD_NAME.postRelationship]: {
     path: `:${PARAMS_RESOURCE_ID}/relationships/:${PARAMS_RELATION_NAME}`,
     name: 'postRelationship',
     method: RequestMethod.POST,
@@ -140,7 +144,7 @@ const Bindings: BindingsConfig = {
       },
     ],
   },
-  deleteRelationship: {
+  [METHOD_NAME.deleteRelationship]: {
     path: `:${PARAMS_RESOURCE_ID}/relationships/:${PARAMS_RELATION_NAME}`,
     name: 'deleteRelationship',
     method: RequestMethod.DELETE,
@@ -162,7 +166,7 @@ const Bindings: BindingsConfig = {
       },
     ],
   },
-  patchRelationship: {
+  [METHOD_NAME.patchRelationship]: {
     path: `:${PARAMS_RESOURCE_ID}/relationships/:${PARAMS_RELATION_NAME}`,
     name: 'patchRelationship',
     method: RequestMethod.PATCH,

libs/json-api/json-api-nestjs/src/lib/modules/mixin/helpers/bind-controller.ts

@@ -41,12 +41,22 @@ export function bindController(
 
     if (!Object.prototype.hasOwnProperty.call(controller.prototype, name)) {
       // need uniq descriptor for correct work swagger
+
+      const func = function (this: typeof controller.prototype,
+        ...arg: Parameters<typeof implementation>
+      ): ReturnType<typeof implementation> {
+        return this.constructor.__proto__.prototype[name].call(this, ...arg);
+      };
+
+      Object.defineProperty(func, 'name', {
+        value: name,
+        writable: false,
+        enumerable: false,
+        configurable: true
+      });
+
       Reflect.defineProperty(controller.prototype, name, {
-        value: function (
-          ...arg: Parameters<typeof implementation>
-        ): ReturnType<typeof implementation> {
-          return this.constructor.__proto__.prototype[name].call(this, ...arg);
-        },
+        value: func,
         writable: true,
         enumerable: false,
         configurable: true,

libs/json-api/json-api-nestjs/src/lib/modules/mixin/helpers/create-controller.spec.ts

@@ -8,6 +8,7 @@ import { createController } from './create-controller';
 import { JsonBaseController } from '../controllers/json-base.controller';
 import {
   JSON_API_CONTROLLER_POSTFIX,
+  JSON_API_DECORATOR_ENTITY,
   ORM_SERVICE,
   ORM_SERVICE_PROPS,
 } from '../../../constants';
@@ -52,12 +53,15 @@ describe('createController', () => {
 
     expect(Reflect.getMetadata(CONTROLLER_WATERMARK, result)).toBe(true);
     expect(Reflect.getMetadata(PATH_METADATA, result)).toBe('users');
+    expect(Reflect.getMetadata(JSON_API_DECORATOR_ENTITY, result)).toBe(Users);
 
     expect(Reflect.getMetadata(CONTROLLER_WATERMARK, result2)).toBe(true);
     expect(Reflect.getMetadata(PATH_METADATA, result2)).toBe('users');
+    expect(Reflect.getMetadata(JSON_API_DECORATOR_ENTITY, result)).toBe(Users);
 
     expect(Reflect.getMetadata(CONTROLLER_WATERMARK, result3)).toBe(true);
     expect(Reflect.getMetadata(PATH_METADATA, result3)).toBe(overrideRoute);
+    expect(Reflect.getMetadata(JSON_API_DECORATOR_ENTITY, result)).toBe(Users);
   });
 
   it('Check inject typeorm, service', () => {

libs/json-api/json-api-nestjs/src/lib/modules/mixin/helpers/create-controller.ts

@@ -2,13 +2,14 @@ import { Controller, Inject, UseInterceptors } from '@nestjs/common';
 import { kebabCase } from 'change-case-commonjs';
 import { ModuleMixinOptions, NestController } from '../../../types';
 import { DecoratorOptions } from '../types';
-import { getProviderName, nameIt } from './utils';
+import { entityForClass, getProviderName, nameIt } from './utils';
 import { JsonBaseController } from '../controllers';
 import {
   JSON_API_DECORATOR_OPTIONS,
   ORM_SERVICE_PROPS,
   ORM_SERVICE,
   JSON_API_CONTROLLER_POSTFIX,
+  JSON_API_DECORATOR_ENTITY,
 } from '../../../constants';
 import { ErrorInterceptors, LogTimeInterceptors } from '../interceptors';
 import { getEntityName } from '@klerick/json-api-nestjs-shared';
@@ -24,6 +25,9 @@ export function createController(
       JsonBaseController
     );
 
+  if(!entityForClass(controllerClass)){
+    Reflect.defineMetadata(JSON_API_DECORATOR_ENTITY, entity, controllerClass)
+  }
   const entityName = getEntityName(entity);
 
   if (

libs/json-api/json-api-nestjs/src/lib/modules/mixin/service/json-api-transformer.service.spec.ts

@@ -55,7 +55,7 @@ describe('JsonApiTransformerService - extractAttributes', () => {
     userObject.firstName = faker.person.firstName();
     userObject.lastName = faker.person.lastName();
     userObject.isActive = null;
-    userObject.login = faker.internet.userName({
+    userObject.login = faker.internet.username({
       lastName: userObject.lastName,
       firstName: userObject.firstName,
     });
@@ -331,7 +331,7 @@ describe('JsonApiTransformerService - extractAttributes', () => {
 
       userObject.manager = {
         id: 1,
-        login: faker.internet.userName({
+        login: faker.internet.username({
           lastName: faker.person.lastName(),
           firstName: faker.person.firstName(),
         }),

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

@@ -20,7 +20,17 @@ describe('Check "filter" zod schema', () => {
         relation: null,
       };
       const result = schema.parse(check1);
-      expect(result).toEqual(check1);
+
+      expect(result).toEqual({
+        ...check1,
+        target: {
+          ...check1.target,
+          id: {
+            gte: 1213,
+            ne: 12,
+          },
+        },
+      });
     });
 
     it('Valid schema - check2', () => {
@@ -42,7 +52,15 @@ describe('Check "filter" zod schema', () => {
         },
       };
       const result = schema.parse(check2);
-      expect(result).toEqual(check2);
+      expect(result).toEqual({
+        ...check2,
+        target: {
+          ...check2.target,
+          id: {
+            gte: 1213,
+          }
+        }
+      });
     });
 
     it('Valid schema - check3', () => {
@@ -71,7 +89,17 @@ describe('Check "filter" zod schema', () => {
         },
       };
       const result = schema.parse(check4);
-      expect(result).toEqual(check4);
+      expect(result).toEqual({
+        ...check4,
+        relation: {
+          ...check4.relation,
+          comments: {
+            id: {
+              lte: 123,
+            },
+          }
+        }
+      });
     });
 
     it('Valid schema - check5', () => {
@@ -108,7 +136,16 @@ describe('Check "filter" zod schema', () => {
         relation: null,
       };
       const result = schema.parse(check6);
-      expect(result).toEqual(check6);
+      expect(result).toEqual({
+        ...check6,
+        target: {
+          ...check6.target,
+          id:{
+            gte: 1213,
+            ne: 123,
+          }
+        },
+      });
     });
 
     it('Valid schema - check7', () => {
@@ -121,7 +158,12 @@ describe('Check "filter" zod schema', () => {
         relation: null,
       };
       const result = schema.parse(check7);
-      expect(result).toEqual(check7);
+      expect(result).toEqual({
+        ...check7,
+        target: {
+          ...check7.target,
+        },
+      });
     });
 
     it('Valid schema - check8', () => {
@@ -134,7 +176,15 @@ describe('Check "filter" zod schema', () => {
         relation: null,
       };
       const result = schema.parse(check8);
-      expect(result).toEqual(check8);
+      expect(result).toEqual({
+        ...check8,
+        target: {
+          ...check8.target,
+          createdAt: {
+            eq: new Date('2023-12-08T09:40:58.020Z'),
+          },
+        },
+      });
     });
 
     it('Valid schema - check9', () => {
@@ -170,6 +220,10 @@ describe('Check "filter" zod schema', () => {
         ...check,
         target: {
           ...check.target,
+          id: {
+            gte: 1213,
+            ne: 123,
+          },
           addresses: {
             eq: 'null',
           },

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

@@ -61,6 +61,22 @@ function getZodRulesForField(type: TypeField = TypeField.string) {
         .refine(stringMustBe(type), {
           error: `String should be as ${type}`,
         })
+        .transform((r) => {
+          if (r === 'null' || r === null) {
+            return r;
+          }
+
+          switch (type) {
+            case TypeField.boolean:
+              return Boolean(r);
+            case TypeField.number:
+              return Number(r);
+            case TypeField.date:
+              return new Date(r);
+          }
+
+          return r;
+        })
         .optional(),
     }),
     {} as {