fix(json-api-nestjs): Route name override

Author: klerick

libs/json-api-nestjs/README.md

@@ -83,6 +83,7 @@ import {ExampleService} from '../../service/example/example.service';
 @JsonApi(Users, {
   allowMethod: excludeMethod(['deleteRelationship']),
   requiredSelectField: true,
+  overrideRoute: 'user',
 })
 export class ExtendUserController extends JsonBaseController<Users> {
   @InjectService() public service: JsonApiService<Users>;

libs/json-api-nestjs/src/lib/decorators/json-api/json-api.decorator.spec.ts

@@ -51,4 +51,18 @@ describe('InjectServiceDecorator', () => {
       Object.keys(Bindings).filter((k) => !example.includes(k))
     );
   });
+
+  it('should save options in class and correctly set overrideRoute', () => {
+    const testedEntity = class SomeEntity {};
+    const apiOptions: DecoratorOptions = {
+      allowMethod: ['getAll', 'deleteRelationship'],
+      overrideRoute: '123'
+    };
+
+    @JsonApi(testedEntity, apiOptions)
+    class SomeClass {}
+
+    const data = Reflect.getMetadata(JSON_API_DECORATOR_OPTIONS, SomeClass);
+    expect(data).toEqual(apiOptions);
+  });
 });

libs/json-api-nestjs/src/lib/helper/swagger/index.ts

@@ -23,7 +23,10 @@ export function setSwaggerDecorator(
   if (!apiTag) {
     const entityName =
       entity instanceof Function ? entity.name : entity.options.name;
-    ApiTags(camelToKebab(entityName))(controller);
+
+    ApiTags(config?.['overrideRoute'] || `${camelToKebab(entityName)}`)(
+      controller
+    );
   }
   ApiExtraModels(FilterOperand)(controller);
   ApiExtraModels(createApiModels(entity))(controller);

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

@@ -18,7 +18,6 @@ import {
   getProviderName,
   camelToKebab,
 } from '../../helper';
-import { JsonBaseController } from '../controller';
 import { typeormMixin, transformMixin } from '../';
 import {
   JSON_API_DECORATOR_OPTIONS,
@@ -46,9 +45,17 @@ BaseModuleClass.forRoot = function (options): DynamicModule {
   const controllerClass =
     controller ||
     nameIt(getProviderName(entity, JSON_API_CONTROLLER_POSTFIX), class {});
+
+  const decoratorOptions: DecoratorOptions = Reflect.getMetadata(
+    JSON_API_DECORATOR_OPTIONS,
+    controllerClass
+  );
+
   const transformService = transformMixin(entity, connectionName);
   const serviceClass = typeormMixin(entity, connectionName, transformService);
-  Controller(`${camelToKebab(entityName)}`)(controllerClass);
+  Controller(decoratorOptions?.['overrideRoute'] || `${camelToKebab(entityName)}`)(
+    controllerClass
+  );
   UseInterceptors(ErrorInterceptors)(controllerClass);
   Inject(serviceClass)(controllerClass.prototype, 'serviceMixin');
   const properties = Reflect.getMetadata(
@@ -73,10 +80,7 @@ BaseModuleClass.forRoot = function (options): DynamicModule {
       controllerClass
     );
   }
-  const decoratorOptions: DecoratorOptions = Reflect.getMetadata(
-    JSON_API_DECORATOR_OPTIONS,
-    controllerClass
-  );
+
   const moduleConfig: ConfigParam = {
     ...ConfigParamDefault,
     ...options.config,

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

@@ -18,6 +18,7 @@ export interface ConfigParam {
   debug: boolean;
   maxExecutionTime: number;
   pipeForId: PipeMixin;
+  overrideRoute?: string;
 }
 
 export interface ModuleOptions {