aloux-iam 0.0.2 → 0.0.3

package/.gitattributes

@@ -1,2 +1,2 @@
-# Auto detect text files and perform LF normalization
-* text=auto
+# Auto detect text files and perform LF normalization
+* text=auto

package/CONTRIBUTING.md

@@ -1 +1 @@
-# How to contribute
+# How to contribute

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 Aloux
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2023 Aloux
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,137 +1,137 @@
-# Aloux SDK
-
-Uso de esta librearía para administración de menus, privilegios, funciones, usuarios y envio de notificaciones por medio de correos y mensajes de texto
-
-## Installation
-
-```bash
-$ npm install aloux-sdk --save
-```
-
-
-## Usage
-En archivo `init.js`
-
-```js
-// Importación
-const { IAMRouter, IAMSwagger } = require('aloux-sdk')
-
-// uso
-app.use(IAMRouter)
-
-// uso swagger
-app.use(
-    "/aloux-sdk",
-    swaggerUI.serveFiles(IAMswagger, {}), 
-    swaggerUI.setup(IAMswagger)
-    )
-
-// URL Swagger
-// [BASE_URL]/docs-iam/#/default/
-
-```
-
-
-En archivo `router.js`
-
-```js
-// Importación
-const { IAMAuth } = require('aloux-sdk')
-
-// uso (ejemplo)
-router.post('/customer', IAMAuth, customer.create)
-```
-
-## Variables de entorno
-
-Requiere las siguientes variables de entorno (.env)
-
-| Variable              |   Description |
-| ----------------------|---------------|
-| AUTH_SECRET           |   Required, para cifrar la contraseña |
-| AWS_SECRET_ACCESS_KEY |   Required, para acceso a S3 y SES AWS. |
-| AWS_ACCESS_KEY_ID     |   Required, para acceso a S3 y SES AWS. |
-| AWS_REGION            |   Required, para acceso a S3 y SES AWS. |
-| AWS_BUCKET            |   Required, para guardar la foto de perfil en AWS. |
-| AWS_EMAIL_SENDER      |   Required, para mandar el correo de recuperación de contraseña |
-| DEBUG                 |   Required, para validar si el ambiente es dev o PROD |
-| MASTER_PWD            |   Optional, para utilizar contraseña maestra de usuarios en desarrollo |
-| BASE_URL              |   Optional, para swagger |
-
-
-## Endpoints disponibles
-
-Endpoints user self (no auth)
-
-| Method    |   Endpoint                |   Description |
-| --------- | --------------------------|---------------|
-| POST      |   iam/user/email              |   Validar correo |
-| POST      |   iam/user/login              |   Iniciar sesión |
-| POST      |   iam/user/forgot/password    |	Enviar código a correo |
-| POST      |   iam/user/validate/code      |   Verificar código |
-| POST      |   iam/user/reset/password     |   Reestablecer contraseña |
-
-
-Endpoints user self
-
-| Method    |   Endpoint                |   Description |
-| --------- | --------------------------|---------------|
-| GET       |	iam/user/me                 |	Obtener información de usuario autenticado |
-| PUT       |	iam/user/profile            |	Actualizar perfil |
-| PUT       |	iam/user/profile/pictura    |	Actualizar solo la foto de perfil |
-| PUT       |	iam/user/reset/password     |	Actualizar contraseña |
-| GET       |	iam/user/logout             |	Cerrar sesión |
-
-
-Endpoints user
-
-| Method    |   Endpoint                    |   Description |
-| --------- | ------------------------------|----------------|
-| POST      |   iam/user                    |	Crear usuario |
-| GET       |	iam/user                    |	Obtener todos los usuario |
-| GET       |	iam/user/:USER_ID           |	Obtener detalle de usuario |
-| PUT       |	iam/user/:USER_ID           |	Actualizar usuario |
-| PUT       |	iam/user/active/:USER_ID    |	Activar o desactivar usuario |
-| PUT       |	iam/user/password/:USER_ID  |	Actualizar la constraseña de un usuario |
-| DELETE    |	iam/user/:USER_ID           |	Eliminar usuario |
-| GET       |	iam/user/count            |	Obtiene el número de usuarios |
-
-
-Endpoints funtions
-
-| Method    |   Endpoint                            |   Description |
-| --------- | --------------------------------------|----------------|
-| POST      |   iam/functions                       |   Crear función |
-| PUT       |	iam/functions/:FUNCTION_ID          |	Actualizar función |
-| PUT       |	iam/functions/active/:FUNCTION_ID   |	Activar o desactivar función |
-| GET       |	iam/functions                       |	Obtener todas las funciones |
-| GET       |	iam/functions/:FUNCTION_ID          |	Obtener detalle de la función |
-| DELETE    |	iam/functions/:FUNCTION_ID          |	Eliminar función |
-| GET       |	iam/functions/count               |	Obtiene el número de funciones |
-
-
-Endpoints permission
-
-| Method    |   Endpoint                                |   Description |
-| --------- | ------------------------------------------|---------------|
-| POST      |	iam/permission                          |   Crear permiso
-| PUT       |	iam/permission/:PERMISSION_ID           |	Actualizar permiso |
-| PUT       |	iam/permission/active/:PERMISSION_ID    |	Activar o desactivar permiso |
-| GET       |	iam/permission                          |   Obtener todas los permisos |
-| GET       |	iam/permission/:PERMISSION_ID           |	Obtener detalle de la permiso |
-| DELETE    |	iam/permission/:PERMISSION_ID           |	Eliminar permiso |
-| GET       |	iam/permission/count                  |	Obtiene el número de permisos |
-
-
-Endpoints menu
-
-| Method    |   Endpoint                |   Description |
-| --------- | --------------------------|---------------|
-| POST      |   /iam/menu               |   Crea un elemento de menú |
-| PUT       |   /iam/menu/:id           |   Actualiza un elemento de menú |
-| PUT       |   /iam/menu/active/:id    |   Activa o desactiva un menú |
-| GET       |   /iam/menu               |   Obtiene todos los elementos de menú |
-| GET       |   /iam/menu/:id           |   Obtiene el detalle de un elemento de menú |
-| DETELE    |   /iam/menu/:id           |   Elimina un elemento de menú |
-| POST      |   /iam/menu/order         |   Ordena los elementos de menú |
+# Aloux IAM
+
+Uso de esta librearía para administración de menus, privilegios, funciones, usuarios y envio de notificaciones por medio de correos y mensajes de texto
+
+## Installation
+
+```bash
+$ npm install aloux-iam --save
+```
+
+
+## Usage
+En archivo `init.js`
+
+```js
+// Importación
+const { IAMRouter, IAMSwagger } = require('aloux-iam')
+
+// uso
+app.use(IAMRouter)
+
+// uso swagger
+app.use(
+    "/aloux-iam",
+    swaggerUI.serveFiles(IAMswagger, {}), 
+    swaggerUI.setup(IAMswagger)
+    )
+
+// URL Swagger
+// [BASE_URL]/docs-iam/#/default/
+
+```
+
+
+En archivo `router.js`
+
+```js
+// Importación
+const { IAMAuth } = require('aloux-iam')
+
+// uso (ejemplo)
+router.post('/customer', IAMAuth, customer.create)
+```
+
+## Variables de entorno
+
+Requiere las siguientes variables de entorno (.env)
+
+| Variable              |   Description |
+| ----------------------|---------------|
+| AUTH_SECRET           |   Required, para cifrar la contraseña |
+| AWS_SECRET_ACCESS_KEY |   Required, para acceso a S3 y SES AWS. |
+| AWS_ACCESS_KEY_ID     |   Required, para acceso a S3 y SES AWS. |
+| AWS_REGION            |   Required, para acceso a S3 y SES AWS. |
+| AWS_BUCKET            |   Required, para guardar la foto de perfil en AWS. |
+| AWS_EMAIL_SENDER      |   Required, para mandar el correo de recuperación de contraseña |
+| DEBUG                 |   Required, para validar si el ambiente es dev o PROD |
+| MASTER_PWD            |   Optional, para utilizar contraseña maestra de usuarios en desarrollo |
+| BASE_URL              |   Optional, para swagger |
+
+
+## Endpoints disponibles
+
+Endpoints user self (no auth)
+
+| Method    |   Endpoint                |   Description |
+| --------- | --------------------------|---------------|
+| POST      |   iam/user/email              |   Validar correo |
+| POST      |   iam/user/login              |   Iniciar sesión |
+| POST      |   iam/user/forgot/password    |	Enviar código a correo |
+| POST      |   iam/user/validate/code      |   Verificar código |
+| POST      |   iam/user/reset/password     |   Reestablecer contraseña |
+
+
+Endpoints user self
+
+| Method    |   Endpoint                |   Description |
+| --------- | --------------------------|---------------|
+| GET       |	iam/user/me                 |	Obtener información de usuario autenticado |
+| PUT       |	iam/user/profile            |	Actualizar perfil |
+| PUT       |	iam/user/profile/pictura    |	Actualizar solo la foto de perfil |
+| PUT       |	iam/user/reset/password     |	Actualizar contraseña |
+| GET       |	iam/user/logout             |	Cerrar sesión |
+
+
+Endpoints user
+
+| Method    |   Endpoint                    |   Description |
+| --------- | ------------------------------|----------------|
+| POST      |   iam/user                    |	Crear usuario |
+| GET       |	iam/user                    |	Obtener todos los usuario |
+| GET       |	iam/user/:USER_ID           |	Obtener detalle de usuario |
+| PUT       |	iam/user/:USER_ID           |	Actualizar usuario |
+| PUT       |	iam/user/active/:USER_ID    |	Activar o desactivar usuario |
+| PUT       |	iam/user/password/:USER_ID  |	Actualizar la constraseña de un usuario |
+| DELETE    |	iam/user/:USER_ID           |	Eliminar usuario |
+| GET       |	iam/user/count            |	Obtiene el número de usuarios |
+
+
+Endpoints funtions
+
+| Method    |   Endpoint                            |   Description |
+| --------- | --------------------------------------|----------------|
+| POST      |   iam/functions                       |   Crear función |
+| PUT       |	iam/functions/:FUNCTION_ID          |	Actualizar función |
+| PUT       |	iam/functions/active/:FUNCTION_ID   |	Activar o desactivar función |
+| GET       |	iam/functions                       |	Obtener todas las funciones |
+| GET       |	iam/functions/:FUNCTION_ID          |	Obtener detalle de la función |
+| DELETE    |	iam/functions/:FUNCTION_ID          |	Eliminar función |
+| GET       |	iam/functions/count               |	Obtiene el número de funciones |
+
+
+Endpoints permission
+
+| Method    |   Endpoint                                |   Description |
+| --------- | ------------------------------------------|---------------|
+| POST      |	iam/permission                          |   Crear permiso
+| PUT       |	iam/permission/:PERMISSION_ID           |	Actualizar permiso |
+| PUT       |	iam/permission/active/:PERMISSION_ID    |	Activar o desactivar permiso |
+| GET       |	iam/permission                          |   Obtener todas los permisos |
+| GET       |	iam/permission/:PERMISSION_ID           |	Obtener detalle de la permiso |
+| DELETE    |	iam/permission/:PERMISSION_ID           |	Eliminar permiso |
+| GET       |	iam/permission/count                  |	Obtiene el número de permisos |
+
+
+Endpoints menu
+
+| Method    |   Endpoint                |   Description |
+| --------- | --------------------------|---------------|
+| POST      |   /iam/menu               |   Crea un elemento de menú |
+| PUT       |   /iam/menu/:id           |   Actualiza un elemento de menú |
+| PUT       |   /iam/menu/active/:id    |   Activa o desactiva un menú |
+| GET       |   /iam/menu               |   Obtiene todos los elementos de menú |
+| GET       |   /iam/menu/:id           |   Obtiene el detalle de un elemento de menú |
+| DETELE    |   /iam/menu/:id           |   Elimina un elemento de menú |
+| POST      |   /iam/menu/order         |   Ordena los elementos de menú |
 | GET       |	iam/menu/count        |	Obtiene el número de menús |

package/index.js

@@ -1,34 +1,34 @@
-const IAMrouter = require('./lib/router')
-const IAMauth = require('./lib/middleware')
-const awsAloux = require('./lib/controllers/operationsAWS')
-const YAML = require('yamljs')
-const path = require('path')
-
-
-const User = require('./lib/models/User')
-const Functions = require('./lib/models/Functions')
-const Permission = require('./lib/models/Permission')
-const Menu = require('./lib/models/Menu')
-
-// swagger
-const swagger_path = path.resolve(__dirname, './lib/swagger.yaml')
-const swagger = YAML.load(swagger_path)
-
-if (process.env.DEBUG === 'true') {
-    swagger['servers'] = []
-    swagger.servers.push({ url: process.env.SWAGGER_SERVER, description: 'DEV' })
-}
-
-
-module.exports = {
-    IAMRouter: IAMrouter,
-    IAMAuth: IAMauth,
-    IAMSwagger: swagger,
-
-    IAMUserModel: User,
-    IAMFunctionsModel: Functions,
-    IAMPermissionModel: Permission,
-    IAMMenuModel: Menu,
-
-    AlouxAWS: awsAloux
+const IAMrouter = require('./lib/router')
+const IAMauth = require('./lib/middleware')
+const awsAloux = require('./lib/controllers/operationsAWS')
+const YAML = require('yamljs')
+const path = require('path')
+
+
+const User = require('./lib/models/User')
+const Functions = require('./lib/models/Functions')
+const Permission = require('./lib/models/Permission')
+const Menu = require('./lib/models/Menu')
+
+// swagger
+const swagger_path = path.resolve(__dirname, './lib/swagger.yaml')
+const swagger = YAML.load(swagger_path)
+
+if (process.env.DEBUG === 'true') {
+    swagger['servers'] = []
+    swagger.servers.push({ url: process.env.SWAGGER_SERVER, description: 'DEV' })
+}
+
+
+module.exports = {
+    IAMRouter: IAMrouter,
+    IAMAuth: IAMauth,
+    IAMSwagger: swagger,
+
+    IAMUserModel: User,
+    IAMFunctionsModel: Functions,
+    IAMPermissionModel: Permission,
+    IAMMenuModel: Menu,
+
+    AlouxAWS: awsAloux
 }

package/lib/config/utils.js

@@ -1,14 +1,14 @@
-const self = module.exports
-
-self.responseError = async (res, error) => {
-    let obj = error
-    if(!error.code){
-        obj = {
-            code: 400,
-            title: 'Error',
-            detail: error.message,
-            suggestion: 'Revisar el detalle'
-        }
-    }
-    res.status(obj.code).send(obj)
+const self = module.exports
+
+self.responseError = async (res, error) => {
+    let obj = error
+    if(!error.code){
+        obj = {
+            code: 400,
+            title: 'Error',
+            detail: error.message,
+            suggestion: 'Revisar el detalle'
+        }
+    }
+    res.status(obj.code).send(obj)
 }