Librería funciones genéricas de backend Red Única

Funciones genéricas de backend para el proyecto de Red Única.

Instalación

  npm install --save @red-unica/libreria-funciones-backend

Uso

  import { funcionGenerica } from '@red-unica/libreria-funciones-backend';

  funcionGenerica();

Funciones

condicionTernaria

Para utilizar esta función se deben envíar las siguientes propiedades:

| Propiedad | Tipo de dato | Opcional | |---------------------|------------------|----------| | condicion | Booleano | No | | valorVerdadero | Cualquiera | No | | valorFalso | Cualquiera | No |

obtenerSemana

Para utilizar esta función se debe envíar la siguiente propiedad:

| Propiedad | Tipo de dato | Opcional | Valor por defecto | |-----------------------|----------------|----------|-------------------| | aumentarDisminuir | Numérico | Si | 0 |

• aumentarDisminuir: Numérico que indica el número de semanas que se suamrán o restarán a la semana actual.

formatoNombre

Para utilizar esta función se debe envíar la siguiente propiedad:

| Propiedad | Tipo de dato | Opcional | |-----------------------|----------------|----------| | nombre | Cadena | No |

• nombre: Cadena el cual se le dara el formato necesario.

verificacionZona

Para utilizar esta función se debe envíar la siguiente propiedad:

| Propiedad | Tipo de dato | Opcional | |-----------------------|----------------|----------| | identificador | Numberico | No | | zonaActiva | Cadena | No |

• identificador: Número que identifica que proceso se esta buscando.
• zonaActiva: Cadena que indica la zona activa en el rancher de producción.

encabezadosRespuesta204

Para utilizar esta función se debe envíar la siguiente propiedad:

| Propiedad | Tipo de dato | Opcional | |-----------------------|----------------|----------| | respuesta | Objeto | No | | numeroAPI | Numerico | Si |

• respuesta: Objeto que contiene el código de respuesta HTTP y la información de las gestiones del cliente que se envía al cliente.
• numeroAPI: Valor numérico que contiene el número de la API que solicita la estructura de los cabeceros (por defecto es 0).

verificacionZonaMongo

Para utilizar esta función se debe envíar la siguiente propiedad:

| Propiedad | Tipo de dato | Opcional | |-----------------------|----------------|----------| | identificador | Numberico | No | | zonaActiva | Cadena | No |

• identificador: Número que identifica que proceso se esta buscando.
• zonaActiva: Cadena que indica la zona activa en el rancher de producción.

desencriptarRSAOAEPWithSHA256AndMGF1Padding

Para utilizar esta función se deben envíar las siguientes propiedades:

| Propiedad | Tipo de dato | Opcional | |-------------------------|--------------|----------| | accesoPrivado | Cadena | No | | cadenaDesencriptar | Cadena | No |

• accesoPrivado: Cadena que contiene el valor del campo "accesoPublico" de la API de Seguridad.
• cadenaDesencriptar: Cadena encriptada con el estándar RSAOAEPWithSHA256AndMGF1Padding que se requiere desencriptar.

encriptarRSAOAEPWithSHA256AndMGF1Padding

Para utilizar esta función se deben enviar las siguientes propiedades:

| Propiedad | Tipo de dato | Opcional | |-------------------------|--------------|----------| | accesoPublico | Cadena | No | | cadenaEncriptar | Cadena | No |

• accesoPublico: Cadena que contiene el valor del campo "accesoPublico" de la API de Seguridad.
• cadenaEncriptar: Cadena que se requiere encriptar con el estándar RSA/ECB/OAEPWithSHA-256AndMGF1Padding.

consumirRecursosPost

Para utilizar esta función se deben envíar las siguientes propiedades:

| Propiedad | Tipo de dato | Opcional | Valor por defecto | |---------------------------------|------------------|----------|-------------------| | configuracion | Objeto | No | N/A | | numeroRecurso | Numérico | No | N/A | | configuracionPeticion | Objeto | No | N/A | | arregloParametrosEncriptar | Arreglo | No | N/A | | numeroAPILlaves | Numérico | Si | 0 | | tiempoEsperaAPI | Numérico | Si | 0 |

• configuracion: Contiene el objeto "process.env" de las variables de entorno.
• numeroRecurso: Acepta los siguientes valores:
  • 1: Recurso plantilla empleados cobranza.
  • 2: Recurso plantilla sucursales cobranza.
  • 3: Recurso identidad digital.
• configuracionPeticion: Contiene la siguiente estructura:

    {
      "parametros": "Objeto",
      "identificadorAcceso": "Cadena",
      "cabeceros": "Arreglo",
    }

  • parametros: Objeto que contiene los parámetros que se enviarán en la petición Post.
  • identificadorAcceso: Cadena que contiene el nombre del cabecero del identificador de acceso (por defecto su valor es 'x-id-acceso').
  • cabeceros: Arreglo que contiene los cabeceros adicionales que se enviarán en la petición Post (por defecto su valor es un arreglo vacio).
• numeroAPILlaves: Acepta los siguientes valores:
  • 1: Seguridad plantilla empleados cobranza.
• tiempoEsperaAPI: Acepta los siguientes valores:
  • 1: Recurso plantilla empleados cobranza.
  • 2: Recurso plantilla sucursales cobranza.
  • 3: Recurso identidad digital.

Version mínima de NodeJS

• Node: "16.15.0"

Instalacion de genericFuntions

Para utilizar esta libreria tienes que tener el tgz de genericFunctions en la raiz de tu proyecto como se muestra:

• genericfunctions: "file:libreriasLocales/genericfunctions-1.0.4.tgz"

License

ISC ©