docs: explicando uso de decorator de audit genérico

src/decorators/audit.decorator.ts

@@ -1,8 +1,22 @@
 import { getSessionData } from '@/utils/utils';
 import { ExecutionContext, createParamDecorator } from '@nestjs/common';
+import { Prisma } from '@prisma/client';
 
-const AuditProperties: <T>(auditProps: (keyof T)[]) => ParameterDecorator =
-  createParamDecorator((auditProps, ctx: ExecutionContext) => {
+/**
+ * Decorator que recupera o ip / id do usuário atual da requisição e permite passar
+ * quais propriedades do modelo do prisma
+ *
+ * ```ts
+ *  updateFoo(@AuditProperties<'User'>(['phone','name']) auditProperties:any)){
+ *  // ...sua lógica aqui
+ *  // irá registar as alterações nos campos `phone` e `name` na auditoria.
+ * }
+ * ```
+ */
+const AuditProperties: <T extends keyof typeof Prisma.ModelName>(
+  auditProps: (keyof Prisma.TypeMap['model'][T]['fields'])[],
+) => ParameterDecorator = createParamDecorator(
+  (auditProps, ctx: ExecutionContext) => {
     const req = ctx.switchToHttp().getRequest();
     const { headers } = req;
     const ipAddress = headers['x-real-ip'] || req.ip;
@@ -14,8 +28,12 @@ const AuditProperties: <T>(auditProps: (keyof T)[]) => ParameterDecorator =
       ipAddress,
       userId,
     };
-  });
+  },
+);
 
+/**
+ * Decorator que recupera o ip / id do usuário atual da requisição.
+ */
 const SessionData = createParamDecorator((_, ctx: ExecutionContext) => {
   const req = ctx.switchToHttp().getRequest();
   const { headers } = req;