feat(json-api-nestjs): Add JSON_API_DECORATOR_ENTITY metadata to controller

The createController now inserts a JSON_API_DECORATOR_ENTITY metadata to the controller class if it is not already present.

Author: klerick

libs/json-api/json-api-nestjs/src/lib/helper/create-controller.ts

@@ -0,0 +1,56 @@
+import { Controller, Inject, Type, UseInterceptors } from '@nestjs/common';
+import { EntityClassOrSchema } from '@nestjs/typeorm/dist/interfaces/entity-class-or-schema.type';
+
+import { camelToKebab, getProviderName, nameIt } from './utils';
+import {
+  JSON_API_CONTROLLER_POSTFIX,
+  JSON_API_DECORATOR_ENTITY,
+  JSON_API_DECORATOR_OPTIONS,
+  TYPEORM_SERVICE,
+  TYPEORM_SERVICE_PROPS,
+} from '../constants';
+import { JsonBaseController } from '../mixin/controller/json-base.controller';
+import { ErrorInterceptors, LogTimeInterceptors } from '../mixin/interceptors';
+
+import { DecoratorOptions } from '../types';
+
+export function createController(
+  entity: EntityClassOrSchema,
+  controller?: Type<any>
+): Type<any> {
+  const controllerClass =
+    controller ||
+    nameIt(
+      getProviderName(entity, JSON_API_CONTROLLER_POSTFIX),
+      JsonBaseController
+    );
+
+  if (!Reflect.hasMetadata(JSON_API_DECORATOR_ENTITY, controllerClass)) {
+    Reflect.defineMetadata(JSON_API_DECORATOR_ENTITY, entity, controllerClass);
+  }
+
+  const entityName =
+    entity instanceof Function ? entity.name : entity.options.name;
+
+  if (
+    !Object.prototype.isPrototypeOf.call(JsonBaseController, controllerClass)
+  ) {
+    throw new Error(
+      `Controller "${controller?.name}" should be inherited of "JsonBaseController"`
+    );
+  }
+
+  const decoratorOptions: DecoratorOptions = Reflect.getMetadata(
+    JSON_API_DECORATOR_OPTIONS,
+    controllerClass
+  );
+
+  Controller(
+    decoratorOptions?.['overrideRoute'] || `${camelToKebab(entityName)}`
+  )(controllerClass);
+
+  Inject(TYPEORM_SERVICE)(controllerClass.prototype, TYPEORM_SERVICE_PROPS);
+  UseInterceptors(LogTimeInterceptors)(controllerClass);
+  UseInterceptors(ErrorInterceptors)(controllerClass);
+  return controllerClass;
+}

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

@@ -5,16 +5,16 @@ import {
   PROPERTY_DEPS_METADATA,
 } from '@nestjs/common/constants';
 import { createController } from './create-controller';
-import { JsonBaseController } from '../controllers/json-base.controller';
+import { Users } from '../mock-utils';
+import { JsonBaseController } from '../mixin/controller/json-base.controller';
 import {
   JSON_API_CONTROLLER_POSTFIX,
-  ORM_SERVICE,
-  ORM_SERVICE_PROPS,
-} from '../../../constants';
+  JSON_API_DECORATOR_ENTITY,
+  TYPEORM_SERVICE,
+  TYPEORM_SERVICE_PROPS,
+} from '../constants';
 import { InjectService, JsonApi } from '../decorators';
-import { ErrorInterceptors, LogTimeInterceptors } from '../interceptors';
-
-class Users {}
+import { ErrorInterceptors, LogTimeInterceptors } from '../mixin/interceptors';
 
 describe('createController', () => {
   it('Should be error', () => {
@@ -49,15 +49,23 @@ describe('createController', () => {
     const result = createController(Users);
     const result2 = createController(Users, TestController);
     const result3 = createController(Users, TestController2);
-
     expect(Reflect.getMetadata(CONTROLLER_WATERMARK, result)).toBe(true);
     expect(Reflect.getMetadata(PATH_METADATA, result)).toBe('users');
+    expect(Reflect.getMetadata(JSON_API_DECORATOR_ENTITY, result)).toEqual(
+      Users
+    );
 
     expect(Reflect.getMetadata(CONTROLLER_WATERMARK, result2)).toBe(true);
     expect(Reflect.getMetadata(PATH_METADATA, result2)).toBe('users');
+    expect(Reflect.getMetadata(JSON_API_DECORATOR_ENTITY, result2)).toEqual(
+      Users
+    );
 
     expect(Reflect.getMetadata(CONTROLLER_WATERMARK, result3)).toBe(true);
     expect(Reflect.getMetadata(PATH_METADATA, result3)).toBe(overrideRoute);
+    expect(Reflect.getMetadata(JSON_API_DECORATOR_ENTITY, result3)).toEqual(
+      Users
+    );
   });
 
   it('Check inject typeorm, service', () => {
@@ -84,13 +92,13 @@ describe('createController', () => {
     expect(intecept).not.toBe(undefined);
     expect(intecept[0]).toEqual(LogTimeInterceptors);
     expect(intecept[1]).toEqual(ErrorInterceptors);
-    expect(check[0].key).toBe(ORM_SERVICE_PROPS);
-    expect(check[0].type).toEqual(ORM_SERVICE);
+    expect(check[0].key).toBe(TYPEORM_SERVICE_PROPS);
+    expect(check[0].type).toEqual(TYPEORM_SERVICE);
 
     expect(check1[0].key).toBe('tmp');
-    expect(check1[0].type).toEqual(ORM_SERVICE);
+    expect(check1[0].type).toEqual(TYPEORM_SERVICE);
 
-    expect(check1[1].key).toBe(ORM_SERVICE_PROPS);
-    expect(check1[1].type).toEqual(ORM_SERVICE);
+    expect(check1[1].key).toBe(TYPEORM_SERVICE_PROPS);
+    expect(check1[1].type).toEqual(TYPEORM_SERVICE);
   });
 });