feat: resource name override

Author: Mateus Garcia

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

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

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

@@ -46,9 +46,19 @@ 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 resourceName = decoratorOptions?.overrideName
+    ? decoratorOptions.overrideName
+    : `${camelToKebab(entityName)}`;
+
   const transformService = transformMixin(entity, connectionName);
   const serviceClass = typeormMixin(entity, connectionName, transformService);
-  Controller(`${camelToKebab(entityName)}`)(controllerClass);
+  Controller(resourceName)(controllerClass);
   UseInterceptors(ErrorInterceptors)(controllerClass);
   Inject(serviceClass)(controllerClass.prototype, 'serviceMixin');
   const properties = Reflect.getMetadata(
@@ -73,10 +83,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;
+  overrideName?: string;
 }
 
 export interface ModuleOptions {