fiscalia_bo-nest-helpers 0.0.15 → 0.0.17

package/.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+    "recommendations": [
+        "stackbreak.comment-divider",
+        "visualstudioexptteam.vscodeintellicode",
+        "esbenp.prettier-vscode",
+        "exodiusstudios.comment-anchors",
+        "usernamehw.errorlens"
+    ]
+}

package/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "cSpell.words": [
+    "fiscalia",
+    "nestjs"
+  ],
+  "dotenv.enableAutocloaking": false
+}

package/README.md

@@ -46,16 +46,22 @@ ENV_SERVICE_MS_FILES='https://ms-files.url'
 
 El módulo MsSeguridadModule proporciona una manera fácil de comunicarse con un servicio de seguridad a través de gRPC.
 
-## Servicios disponibles
+## Modulos disponibles
 
 - MsSeguridadModule
+
+## Servicios disponibles
+
 - MsSeguridadService
 
+para utilizar el servicio de seguridad es necesario importar el modulo `MsSeguridadModule`
+
 ## Configuración
 
 Antes de utilizar el módulo, asegúrese de tener las siguientes variables de entorno configuradas:
 
 - `ENV_GRPC_MS_SEGURIDAD`: la URL del servidor de seguridad a través de gRPC.
+- `ENV_GRPC_MS_REDIS_CACHE`: la URL del servidor de cacheo de redis a través de gRPC.
 
 ## Uso
 
@@ -68,7 +74,13 @@ import { MsSeguridadModule } from 'fiscalia_bo-nest-helpers/seguridad';
 @Module({
   imports: [
     ConfigModule.forRoot({ isGlobal: true }),
-    MsSeguridadModule.register({ url: process.env.ENV_GRPC_MS_SEGURIDAD || '' }),
+
+    // Register ms-seguridad module global
+    MsSeguridadModule.register({
+      global: true,
+      urlSeguridad: process.env.ENV_GRPC_MS_SEGURIDAD,
+      urlRedisCache: process.env.ENV_GRPC_MS_REDIS_CACHE,
+    }),
   ],
   controllers: [],
   providers: [],
@@ -76,11 +88,94 @@ import { MsSeguridadModule } from 'fiscalia_bo-nest-helpers/seguridad';
 export class AppModule {}
 ```
 
-> **NOTA IMPORTANTE:** previo al uso del modulO debe importarse el [`ConfigModule`](https://docs.nestjs.com/techniques/configuration#getting-started "Nestjs Docs") de nestjs y configurarlo para uso global
+> **NOTA IMPORTANTE:** previo al uso del modulO debe importarse el [`ConfigModule`](https://docs.nestjs.com/techniques/configuration#getting-started 'Nestjs Docs') de nestjs y configurarlo para uso global
 
 En este ejemplo, estamos utilizando el método register para cargar la configuración de forma `síncrona`
 
-## Información
+## decoradores disponibles para controller
+
+- `@BearerAuthPermision()`, decorador auth que realiza 3 verificaciones antes de entrar a un controller.
+
+  - verifica automaticamente que existe `token bearer` en el header de la peticion
+  - verifica que el token se válido
+  - Si este decorador recibe permisos por parametro entonces verifica que cumpla con todos los permisos indicados por parametro
+
+- `@VersionDescription(version, descripcion)`, decorador que aplica version y descripcion a un controller.
+- `@AuthUser()`, decorador para obtener los datos del token como ser:
+  - ci: string;
+  - idAplicacion: number;
+  - idFuncionario: number;
+  - idPersona: number;
+  - usuarioId: number;
+- `@AuthToken()`, decorador para obtener el token de tipo string
+
+- `@AuthPermissions()`, decorador para obtener la lista de permisos, devuelve array de string.
+
+ejempos de uso:
+
+```js
+  // EJEMPLO 1
+  @Get(':id')
+  @BearerAuthPermision()
+  findOne(@Param('id') id: number) {
+    return this.casosPersonaService.findOne(+id);
+  }
+
+  // EJEMPLO 2
+  @Post('test-seguridad')
+  @BearerAuthPermision(['ALGUN_PERMISOS'])
+  async test(
+    @Body() body: TokenBody,
+    @AuthUser() user: UserPayload, //  controlador
+    @AuthToken() token: string,
+    @AuthPermissions() permissions: string[],
+  ) {
+    return {
+      some: 'algo',
+    };
+  }
+```
+
+# USO DEL SERVICIO `MS-REDIS`
+Antes de utilizar el módulo, asegúrese de tener las siguientes variables de entorno configuradas:
+
+- `ENV_GRPC_MS_REDIS_CACHE`: la URL del servidor de cacheo de redis a través de gRPC.
+
+## Uso
+
+Para utilizar el módulo, primero importe `MsRedisModule` en su módulo principal:
+
+```typescript
+import { Module } from '@nestjs/common';
+import { MsRedisModule } from 'fiscalia_bo-nest-helpers/seguridad';
+
+@Module({
+  imports: [
+    ConfigModule.forRoot({ isGlobal: true }),
+
+    // Register ms-seguridad module global
+    MsRedisModule.register({ urlRedisCache: process.env.ENV_GRPC_MS_REDIS_CACHE || '' }),
+  ],
+  controllers: [],
+  providers: [],
+})
+export class AppModule {}
+```
+## Servicios disponibles
+
+- MsRedisService
+### Nomenclatura de asignacion de key para redis
+
+
+```txt
+aplicacion-name:key_One-key_Two-key_Three-keyAcction
+```
+ejemplo de asignacion de key para redis
+```js
+const keyCache = `ms-seguridad:usuarioId_${usuarioId}-aplicacionId_${aplicacionId}-permisos`;
+```
+
+# Información
 
 - Author - [UTIC](mailto:informatica@fiscalia.gob.bo)
 

package/dist/ms-seguridad/ms-seguridad.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"ms-seguridad.decorator.js","sourceRoot":"","sources":["../../src/ms-seguridad/ms-seguridad.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAoG;AACpG,6CAAgD;AAChD,yDAAoD;AACpD,uDAA0E;AAEnE,MAAM,mBAAmB,GAAG,CAAC,WAAsB,EAAE,EAAE;IAC5D,MAAM,UAAU,GAAG,CAAC,IAAA,uBAAa,GAAE,EAAE,IAAA,kBAAS,EAAC,iCAAc,EAAE,kCAAgB,CAAC,CAAC,CAAC;IAElF,IAAI,WAAW,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;QACzC,UAAU,CAAC,IAAI,CAAC,IAAA,qCAAmB,EAAC,GAAG,WAAW,CAAC,CAAC,CAAC;KACtD;IACD,OAAO,IAAA,wBAAe,EAAC,GAAG,UAAU,CAAC,CAAC;AACxC,CAAC,CAAC;AAPW,QAAA,mBAAmB,uBAO9B;AAEF,MAAa,WAAW;CAMvB;AAND,kCAMC;AAEY,QAAA,QAAQ,GAAG,IAAA,6BAAoB,EAC1C,CAAC,IAAa,EAAE,OAAyB,EAAe,EAAE;IACxD,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;IACpD,OAAO,OAAO,CAAC,UAAU,CAAC;AAC5B,CAAC,CACF,CAAC;AAEW,QAAA,SAAS,GAAG,IAAA,6BAAoB,EAC3C,CAAC,IAAa,EAAE,OAAyB,EAAU,EAAE;IACnD,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;IACpD,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;IAEjD,IAAI,CAAC,UAAU;QAAE,OAAO,IAAI,CAAC;IAE7B,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9C,OAAO,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,MAAM,CAAC;AACzB,CAAC,CACF,CAAC;AAEW,QAAA,eAAe,GAAG,IAAA,6BAAoB,EACjD,CAAC,IAAa,EAAE,OAAyB,EAAU,EAAE;;IACnD,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;IACpD,OAAO,MAAA,OAAO,CAAC,WAAW,mCAAI,EAAE,CAAC;AACnC,CAAC,CACF,CAAC"}
+{"version":3,"file":"ms-seguridad.decorator.js","sourceRoot":"","sources":["../../src/ms-seguridad/ms-seguridad.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAoG;AACpG,6CAAgD;AAChD,yDAAoD;AACpD,uDAA0E;AAEnE,MAAM,mBAAmB,GAAG,CAAC,WAAsB,EAAE,EAAE;IAC5D,MAAM,UAAU,GAAG,CAAC,IAAA,uBAAa,GAAE,EAAE,IAAA,kBAAS,EAAC,iCAAc,EAAE,kCAAgB,CAAC,CAAC,CAAC;IAElF,IAAI,WAAW,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;QACzC,UAAU,CAAC,IAAI,CAAC,IAAA,qCAAmB,EAAC,GAAG,WAAW,CAAC,CAAC,CAAC;KACtD;IACD,OAAO,IAAA,wBAAe,EAAC,GAAG,UAAU,CAAC,CAAC;AACxC,CAAC,CAAC;AAPW,QAAA,mBAAmB,uBAO9B;AAEF,MAAa,WAAW;CAMvB;AAND,kCAMC;AAEY,QAAA,QAAQ,GAAG,IAAA,6BAAoB,EAC1C,CAAC,IAAa,EAAE,OAAyB,EAAe,EAAE;IACxD,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;IACpD,OAAO,OAAO,CAAC,UAAU,CAAC;AAC5B,CAAC,CACF,CAAC;AAEW,QAAA,SAAS,GAAG,IAAA,6BAAoB,EAC3C,CAAC,IAAa,EAAE,OAAyB,EAAU,EAAE;IACnD,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;IACpD,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;IAEjD,IAAI,CAAC,UAAU;QAAE,OAAO,IAAI,CAAC;IAE7B,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9C,OAAO,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,MAAM,CAAC;AACzB,CAAC,CACF,CAAC;AAEW,QAAA,eAAe,GAAG,IAAA,6BAAoB,EACjD,CAAC,IAAa,EAAE,OAAyB,EAAY,EAAE;;IACrD,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;IACpD,OAAO,MAAA,OAAO,CAAC,WAAW,mCAAI,EAAE,CAAC;AACnC,CAAC,CACF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fiscalia_bo-nest-helpers",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "author": "UTIC",
   "contact": {
     "name": "Unidad de Tecnologías de la Información y Comunicación - Ministerio Público",