fixed all imports and routes

This commit is contained in:
Pau 2025-04-06 18:37:49 +02:00
parent 54569642e5
commit 7639c02a82
2 changed files with 659 additions and 19 deletions

View File

@ -62,8 +62,8 @@ app.use((req, res) => {
const port = config.port || 3000 const port = config.port || 3000
const server = (NODE_ENV === 'development' ? app : https.createServer(httpsOptions(), app)).listen(port, () => { const server = (NODE_ENV === 'development' ? app : https.createServer(httpsOptions(), app)).listen(port, () => {
// eslint-disable-next-line no-console //eslint-disable-next-line no-console
console.log(`Server listening on port ${port}`) console.log(`Server listening on port ${port}`)
}) })
export { app, linkRoutes, server } export { app, linkRoutes, server }

View File

@ -20,12 +20,48 @@ import { integer, uuid, varChar} from '../validators/expressValidator/customVali
import {payloadExpressValidator} from '../validators/expressValidator/payloadExpressValidator.js' import {payloadExpressValidator} from '../validators/expressValidator/payloadExpressValidator.js'
import { error422, errorHandler } from '../utils/errors.js' import { error422, errorHandler } from '../utils/errors.js'
import { authorizePermission, setToken, authenticateToken} from '../middlewares/auth.js' import { authorizePermission, setToken, authenticateToken} from '../middlewares/auth.js'
import { postRegisterController } from '../controllers/authorization/registerController.js'
import { postRefreshTokenController } from '../controllers/authorization/refreshTokenController.js'
import {
getEndpointsByRouteController,
getEndpointsController,
getEndpointsByUuidController,
postEndpointsController,
putEndpointsController,
deleteEndpointsController,
softDeleteEndpointsController
} from '../controllers/authorization/endpointsController.js'
import {
getRolesHasPermissionsController,
postRolesHasPermissionsController,
putRolesHasPermissionsController,
softDeleteRolesHasPermissionsController,
} from '../controllers/authorization/roles_has_permissionsController.js'
import {
getUsersHasDevicesController,
postUsersHasDevicesController,
putUsersHasDevicesController,
softDeleteUsersHasDevicesController,
} from '../controllers/resource_types/usersHasDevicesController.js'
/** /**
* @function default * @function default
* @param {Object} configuration based on environment * @param {Object} configuration based on environment
* @returns {Router} all endpoint routes * @returns {Router} all endpoint routes
*/ */
/**
* @fileoverview This file defines the routes for the REST API, including endpoints for devices, users, roles, permissions, and login.
* It uses Express.js to define and manage routes, and includes middleware for authentication, authorization, validation, and response handling.
*
* @module routes/index
* @requires express.Router
* @requires controllers
* @requires middlewares
* @requires validators
*
* @param {Object} config - Configuration object for the application.
* @param {string} config.environment - The current environment (e.g., 'production', 'development').
* @returns {Object} routes - The configured Express router with all defined routes.
*/
export default(config) => { export default(config) => {
/** /**
* Express router to mount user related functions on. * Express router to mount user related functions on.
@ -50,12 +86,28 @@ export default(config) => {
*/ */
routes.get( routes.get(
'/', '/',
(req, res, next) => indexController(req, res, next, config), (req, res, next) => indexController(req, res, next),
(result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes), (result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes),
(result, req, res, _) => sendOkResponse(result, req, res) (result, req, res, _) => sendOkResponse(result, req, res)
) )
// User Routes // User Routes
/**
* @name get/users
* @function
* @inner
* @memberof deviceRouter
* @route GET /users
* @group Users - Operations about users
* @param {string} uuid.path.required - The unique identifier for the user
* @param {string} username.path.required - The username of the user
* @param {string} email.path.required - The email of the user
* @returns {User} 200 - The user object
* @returns {ErrorResponse} 404 - User not found
* @returns {ErrorResponse} 422 - Unprocessable entity
* @returns {ErrorResponse} 500 - Internal server error
* @returns {ErrorResponse} 403 - Forbidden
* */
routes.get( routes.get(
'/users', '/users',
(req, res, next) => authenticateToken(req, res, next, config), (req, res, next) => authenticateToken(req, res, next, config),
@ -71,6 +123,23 @@ export default(config) => {
(result, req, res, _) => sendOkResponse(result, req, res) (result, req, res, _) => sendOkResponse(result, req, res)
); );
/**
* @name get/users/:uuid
* @function
* @inner
* @memberof deviceRouter
* @route GET /users/{uuid}
* @group Users - Operations about users
* @param {string} uuid.path.required - The unique identifier for the user
* @param {string} username.path.required - The username of the user
* @param {string} email.path.required - The email of the user
* @returns {User} 200 - The user object
* @returns {ErrorResponse} 404 - User not found
* @returns {ErrorResponse} 422 - Unprocessable entity
* @returns {ErrorResponse} 500 - Internal server error
* @returns {ErrorResponse} 403 - Forbidden
* @returns {ErrorResponse} 401 - Unauthorized
*/
routes.get( routes.get(
'/users/:uuid', '/users/:uuid',
(req, res, next) => authenticateToken(req, res, next, config), (req, res, next) => authenticateToken(req, res, next, config),
@ -84,15 +153,36 @@ export default(config) => {
(result, req, res, _) => sendOkResponse(result, req, res) (result, req, res, _) => sendOkResponse(result, req, res)
); );
/**
* @name POST/users
* @function
* @inner
* @memberof deviceRouter
* @route POST /users
* @group Users - Operations about users
* @param {string} username.path.required - The username of the user
* @param {string} password.path.required - The password of the user
* @param {string} email.path.required - The email of the user
* @param {string} fk_role.path.required - The role of the user
* @param {string} uuid.path.required - The unique identifier for the user
* @returns {SuccessResponse} 200 - User created successfully
* @returns {ErrorResponse} 400 - Bad request
* @returns {ErrorResponse} 404 - User not found
* @returns {ErrorResponse} 422 - Unprocessable entity
* @returns {ErrorResponse} 500 - Internal server error
* @returns {ErrorResponse} 403 - Forbidden
*/
routes.post( routes.post(
'/users', '/users',
(req, res, next) => authenticateToken(req, res, next, config), (req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/users')(req, res, next, config), (req, res, next) => authorizePermission('/users')(req, res, next, config),
[ [
varChar('username'), uuid('uuid').optional({ nullable: false, values: 'falsy' }),
varChar('password'), varChar('username').optional({ nullable: false, values: 'falsy' }),
varChar('password').optional({ nullable: false, values: 'falsy' }),
varChar('email').optional({ nullable: true, values: 'falsy' }), varChar('email').optional({ nullable: true, values: 'falsy' }),
uuid('fk_role') varChar('fk_role').optional({ nullable: false, values: 'falsy' })
], ],
(req, res, next) => payloadExpressValidator(req, res, next, config), (req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => postUserController(req, res, next, config), (req, res, next) => postUserController(req, res, next, config),
@ -100,6 +190,26 @@ export default(config) => {
(result, req, res, _) => sendCreatedResponse(result, req, res) (result, req, res, _) => sendCreatedResponse(result, req, res)
); );
/**
* @name PUT/users/:uuid
* @function
* @inner
* @memberof deviceRouter
* @route PUT /users/{uuid}
* @group Users - Operations about users
* @param {string} uuid.path.required - The unique identifier for the user
* @param {string} username.path.required - The username of the user
* @param {string} email.path.required - The email of the user
* @param {string} fk_role.path.required - The role of the user
* @param {string} password.path.required - The password of the user
* @returns {SuccessResponse} 200 - User updated successfully
* @returns {ErrorResponse} 400 - Bad request
* @returns {ErrorResponse} 404 - User not found
* @returns {ErrorResponse} 422 - Unprocessable entity
* @returns {ErrorResponse} 500 - Internal server error
* @returns {ErrorResponse} 403 - Forbidden
* @returns {ErrorResponse} 401 - Unauthorized
*/
routes.put( routes.put(
'/users/:uuid', '/users/:uuid',
(req, res, next) => authenticateToken(req, res, next, config), (req, res, next) => authenticateToken(req, res, next, config),
@ -116,7 +226,21 @@ export default(config) => {
(result, req, res, _) => sendCreatedResponse(result, req, res) (result, req, res, _) => sendCreatedResponse(result, req, res)
); );
routes.put( /**
* @name delete/users/:uuid
* @function
* @inner
* @memberof deviceRouter
* @route DELETE /users/{uuid}
* @group Users - Operations about users
* @param {string} uuid.path.required - The unique identifier for the user
* @returns {SuccessResponse} 204 - User deleted successfully. No content
* @returns {ErrorResponse} 404 - User not found
* @returns {ErrorResponse} 422 - Unprocessable entity
* @returns {ErrorResponse} 500 - Internal server error
* @returns {ErrorResponse} 403 - Forbidden
*/
routes.delete(
'/users/:uuid', '/users/:uuid',
(req, res, next) => authenticateToken(req, res, next, config), (req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/users/:uuid')(req, res, next, config), (req, res, next) => authorizePermission('/users/:uuid')(req, res, next, config),
@ -129,20 +253,57 @@ export default(config) => {
(result, req, res, _) => sendResponseNoContent(result, req, res) (result, req, res, _) => sendResponseNoContent(result, req, res)
); );
/**
* @name GET/roles
* @function
* @inner
* @memberof deviceRouter
* @route GET /roles
* @group Roles - Operations about roles
* @param {string} uuid.path.required - The unique identifier for the role
* @param {string} name.path.required - The name of the role
* @returns {SuccessResponse} 200 - The role object
* @returns {ErrorResponse} 404 - Role not found
* @returns {ErrorResponse} 422 - Unprocessable entity
* @returns {ErrorResponse} 500 - Internal server error
* @returns {ErrorResponse} 403 - Forbidden
* @returns {ErrorResponse} 401 - Unauthorized
* @returns {ErrorResponse} 400 - Bad request
*/
routes.get( routes.get(
'/roles', '/roles',
(req, res, next) => authenticateToken(req, res, next, config), (req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/roles')(req, res, next, config),
(req, res, next) => payloadExpressValidator(req, res, next, config), (req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => getRoleController(req, res, next, config), (req, res, next) => getRoleController(req, res, next, config),
(result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes), (result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes),
(result, req, res, _) => sendOkResponse(result, req, res) (result, req, res, _) => sendOkResponse(result, req, res)
); );
/**
* @name GET/roles/:uuid
* @function
* @inner
* @memberof deviceRouter
* @route GET /roles/{uuid}
* @group Roles - Operations about roles
* @param {string} uuid.path.required - The unique identifier for the role
* @param {string} name.path.required - The name of the role
* @returns {SuccessResponse} 200 - The role object
* @returns {ErrorResponse} 404 - Role not found
* @returns {ErrorResponse} 422 - Unprocessable entity
* @returns {ErrorResponse} 500 - Internal server error
* @returns {ErrorResponse} 403 - Forbidden
* @returns {ErrorResponse} 401 - Unauthorized
* @returns {ErrorResponse} 400 - Bad request
*/
routes.get( routes.get(
'/roles/:uuid', '/roles/:uuid',
(req, res, next) => authenticateToken(req, res, next, config), (req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/roles/:uuid')(req, res, next, config),
[ [
uuid('uuid') uuid('uuid').optional({ nullable: false, values: 'falsy' }),
varChar('name').optional({ nullable: false, values: 'falsy' })
], ],
(req, res, next) => payloadExpressValidator(req, res, next, config), (req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => getRoleInfoController(req, res, next, config), (req, res, next) => getRoleInfoController(req, res, next, config),
@ -150,11 +311,29 @@ export default(config) => {
(result, req, res, _) => sendOkResponse(result, req, res) (result, req, res, _) => sendOkResponse(result, req, res)
); );
/**
* @name POST/roles
* @function
* @inner
* @memberof deviceRouter
* @route POST /roles
* @group Roles - Operations about roles
* @param {string} name.path.required - The name of the role
* @param {string} uuid.path.required - The unique identifier for the role
* @returns {SuccessResponse} 200 - Role created successfully
* @returns {ErrorResponse} 400 - Bad request
* @returns {ErrorResponse} 404 - Role not found
* @returns {ErrorResponse} 422 - Unprocessable entity
* @returns {ErrorResponse} 500 - Internal server error
* @returns {ErrorResponse} 403 - Forbidden
*/
routes.post( routes.post(
'/roles', '/roles',
(req, res, next) => authenticateToken(req, res, next, config), (req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/roles')(req, res, next, config),
[ [
varChar('name') uuid('uuid').optional({ nullable: false, values: 'falsy' }),
varChar('name').optional({nullable: false, values: 'falsy'})
], ],
(req, res, next) => payloadExpressValidator(req, res, next, config), (req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => postRoleController(req, res, next, config), (req, res, next) => postRoleController(req, res, next, config),
@ -162,11 +341,30 @@ export default(config) => {
(result, req, res, _) => sendCreatedResponse(result, req, res) (result, req, res, _) => sendCreatedResponse(result, req, res)
); );
/**
* @name PUT/roles/:uuid
* @function
* @inner
* @memberof deviceRouter
* @route PUT /roles/{uuid}
* @group Roles - Operations about roles
* @param {string} uuid.path.required - The unique identifier for the role
* @param {string} name.path.required - The name of the role
* @param {string} fk_permission.path.required - The permission of the role
* @returns {SuccessResponse} 200 - Role updated successfully
* @returns {ErrorResponse} 400 - Bad request
* @returns {ErrorResponse} 404 - Role not found
* @returns {ErrorResponse} 422 - Unprocessable entity
* @returns {ErrorResponse} 500 - Internal server error
* @returns {ErrorResponse} 403 - Forbidden
* @returns {ErrorResponse} 401 - Unauthorized
*/
routes.put( routes.put(
'/roles/:uuid', '/roles/:uuid',
(req, res, next) => authenticateToken(req, res, next, config), (req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/roles/:uuid')(req, res, next, config),
[ [
uuid('uuid'), uuid('uuid').optional({ nullable: false, values: 'falsy' }),
varChar('name').optional({ nullable: false, values: 'falsy' }) varChar('name').optional({ nullable: false, values: 'falsy' })
], ],
(req, res, next) => payloadExpressValidator(req, res, next, config), (req, res, next) => payloadExpressValidator(req, res, next, config),
@ -175,11 +373,30 @@ export default(config) => {
(result, req, res, _) => sendCreatedResponse(result, req, res) (result, req, res, _) => sendCreatedResponse(result, req, res)
); );
/**
* @name DELETE/roles/:uuid
* @function
* @inner
* @memberof deviceRouter
* @route DELETE /roles/{uuid}
* @group Roles - Operations about roles
* @param {string} uuid.path.required - The unique identifier for the role
* @param {string} name.path.required - The name of the role
* @returns {SuccessResponse} 204 - Role deleted successfully. No content
* @returns {ErrorResponse} 404 - Role not found
* @returns {ErrorResponse} 422 - Unprocessable entity
* @returns {ErrorResponse} 500 - Internal server error
* @returns {ErrorResponse} 403 - Forbidden
* @returns {ErrorResponse} 401 - Unauthorized
* @returns {ErrorResponse} 400 - Bad request
*/
routes.delete( routes.delete(
'/roles/:uuid', '/roles/:uuid',
(req, res, next) => authenticateToken(req, res, next, config), (req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/roles/:uuid')(req, res, next, config),
[ [
uuid('uuid') uuid('uuid').optional({ nullable: false, values: 'falsy' }),
varChar('name').optional({ nullable: false, values: 'falsy' })
], ],
(req, res, next) => payloadExpressValidator(req, res, next, config), (req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => deleteRoleController(req, res, next, config), (req, res, next) => deleteRoleController(req, res, next, config),
@ -187,23 +404,61 @@ export default(config) => {
(result, req, res, _) => sendResponseNoContent(result, req, res) (result, req, res, _) => sendResponseNoContent(result, req, res)
); );
// Permission Routes
/**
* @name GET/permissions
* @function
* @inner
* @memberof deviceRouter
* @route GET /permissions
* @group Permissions - Operations about permissions
* @param {string} uuid.path.required - The unique identifier for the permission
* @param {string} name.path.required - The name of the permission
* @returns {SuccessResponse} 200 - The permission object
* @returns {ErrorResponse} 404 - Permission not found
* @returns {ErrorResponse} 422 - Unprocessable entity
* @returns {ErrorResponse} 500 - Internal server error
* @returns {ErrorResponse} 403 - Forbidden
* */
routes.get( routes.get(
'/permissions', '/permissions',
(req, res, next) => authenticateToken(req, res, next, config), (req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/permissions')(req, res, next, config),
[
uuid('uuid').optional({ nullable: false, values: 'falsy' }),
varChar('name').optional({ nullable: false, values: 'falsy' })
],
(req, res, next) => payloadExpressValidator(req, res, next, config), (req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => getPermissionController(req, res, next, config), (req, res, next) => getPermissionListController(req, res, next, config),
(result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes), (result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes),
(result, req, res, _) => sendOkResponse(result, req, res) (result, req, res, _) => sendOkResponse(result, req, res)
); );
/**
* @name GET/permissions/:uuid
* @function
* @inner
* @memberof deviceRouter
* @route GET /permissions/{uuid}
* @group Permissions - Operations about permissions
* @param {string} uuid.path.required - The unique identifier for the permission
* @param {string} name.path.required - The name of the permission
* @returns {SuccessResponse} 200 - The permission object
* @returns {ErrorResponse} 404 - Permission not found
* @returns {ErrorResponse} 422 - Unprocessable entity
* @returns {ErrorResponse} 500 - Internal server error
* @returns {ErrorResponse} 403 - Forbidden
* */
routes.get( routes.get(
'/permissions/:uuid', '/permissions/:uuid',
(req, res, next) => authenticateToken(req, res, next, config), (req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/permissions')(req, res, next, config),
[ [
uuid('uuid') uuid('uuid').optional({ nullable: false, values: 'falsy' }),
varChar('name').optional({ nullable: false, values: 'falsy' })
], ],
(req, res, next) => payloadExpressValidator(req, res, next, config), (req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => getPermissionByUuidController(req, res, next, config), (req, res, next) => getPermissionListController(req, res, next, config),
(result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes), (result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes),
(result, req, res, _) => sendOkResponse(result, req, res) (result, req, res, _) => sendOkResponse(result, req, res)
); );
@ -211,8 +466,10 @@ export default(config) => {
routes.post( routes.post(
'/permissions', '/permissions',
(req, res, next) => authenticateToken(req, res, next, config), (req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/permissions')(req, res, next, config),
[ [
varChar('name') uuid('uuid').optional({ nullable: false, values: 'falsy' }),
varChar('name').optional({ nullable: false, values: 'falsy' })
], ],
(req, res, next) => payloadExpressValidator(req, res, next, config), (req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => postPermissionController(req, res, next, config), (req, res, next) => postPermissionController(req, res, next, config),
@ -220,11 +477,32 @@ export default(config) => {
(result, req, res, _) => sendCreatedResponse(result, req, res) (result, req, res, _) => sendCreatedResponse(result, req, res)
); );
/**
* @name PUT/permissions/:uuid
* @function
* @inner
* @memberof deviceRouter
* @route PUT /permissions/{uuid}
* @group Permissions - Operations about permissions
* @param {string} uuid.path.required - The unique identifier for the permission
* @param {string} action.path - The name of the action/http method for the request
* @param {string} endpoint.path - The name of the permission
* @returns {SuccessResponse} 200 - Permission updated successfully
* @returns {ErrorResponse} 400 - Bad request
* @returns {ErrorResponse} 404 - Permission not found
* @returns {ErrorResponse} 422 - Unprocessable entity
* @returns {ErrorResponse} 500 - Internal server error
* @returns {ErrorResponse} 403 - Forbidden
* @returns {ErrorResponse} 401 - Unauthorized
* */
routes.put( routes.put(
'/permissions/:uuid', '/permissions/:uuid',
(req, res, next) => authenticateToken(req, res, next, config), (req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/permissions/:uuid')(req, res, next, config),
[ [
uuid('uuid') uuid('uuid').optional({ nullable: false, values: 'falsy' }),
varChar('action').optional({ nullable: false, values: 'falsy' }),
varChar('endpoint').optional({ nullable: false, values: 'falsy' })
], ],
(req, res, next) => payloadExpressValidator(req, res, next, config), (req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => putPermissionController(req, res, next, config), (req, res, next) => putPermissionController(req, res, next, config),
@ -232,12 +510,28 @@ export default(config) => {
(result, req, res, _) => sendCreatedResponse(result, req, res) (result, req, res, _) => sendCreatedResponse(result, req, res)
); );
/**
* @name DELETE/permissions/:uuid
* @function
* @inner
* @memberof deviceRouter
* @route DELETE /permissions/{uuid}
* @group Permissions - Operations about permissions
* @param {string} uuid.path.required - The unique identifier for the permission
* @param {string} name.path.required - The name of the permission
* @returns {SuccessResponse} 200 - Permission deleted successfully
* @returns {ErrorResponse} 404 - Permission not found
* @returns {ErrorResponse} 422 - Unprocessable entity
* @returns {ErrorResponse} 500 - Internal server error
* @returns {ErrorResponse} 403 - Forbidden
*/
routes.delete( routes.delete(
'/permissions/:uuid', '/permissions/:uuid',
(req, res, next) => authenticateToken(req, res, next, config), (req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('permissions')(req, res, next, config), (req, res, next) => authorizePermission('/permissions/:uuid')(req, res, next, config),
[ [
uuid('uuid') uuid('uuid').optional({ nullable: false, values: 'falsy' }),
], ],
(req, res, next) => payloadExpressValidator(req, res, next, config), (req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => softDeletePermissionController(req, res, next, config), (req, res, next) => softDeletePermissionController(req, res, next, config),
@ -245,7 +539,330 @@ export default(config) => {
(result, req, res, _) => sendResponseNoContent(result, req, res) (result, req, res, _) => sendResponseNoContent(result, req, res)
); );
// User Permission Routes
/**
* @name GET/user_permissions
* @function
* @inner
* @memberof deviceRouter
* @route GET /user_permissions
* @group User Permissions - Operations about user permissions
* @param {string} uuid.path.required - The unique identifier for the user permission
* @param {string} fk_user.path.required - The unique identifier for the user
* @param {string} fk_permission.path.required - The unique identifier for the permission
* @returns {SuccessResponse} 200 - The user permission object
* @returns {ErrorResponse} 404 - User permission not found
* @returns {ErrorResponse} 422 - Unprocessable entity
* @returns {ErrorResponse} 500 - Internal server error
* @returns {ErrorResponse} 403 - Forbidden
*/
routes.get(
'/user_permissions',
(req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/user_permissions')(req, res, next, config),
[
uuid('uuid').optional({ nullable: false, values: 'falsy' }),
uuid('fk_user').optional({ nullable: false, values: 'falsy' }),
uuid('fk_permission').optional({ nullable: false, values: 'falsy' })
],
(req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => getUserPermissionController(req, res, next, config),
(result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes),
(result, req, res, _) => sendOkResponse(result, req, res)
);
/**
* @name GET/user_permissions/:uuid
* @function
* @inner
* @memberof deviceRouter
* @route GET /user_permissions/{uuid}
* @group User Permissions - Operations about user permissions
* @param {string} uuid.path.required - The unique identifier for the user permission
* @param {string} fk_user.path.required - The unique identifier for the user
* @param {string} fk_permission.path.required - The unique identifier for the permission
* @returns {SuccessResponse} 200 - The user permission object
* @returns {ErrorResponse} 404 - User permission not found
* @returns {ErrorResponse} 422 - Unprocessable entity
* @returns {ErrorResponse} 500 - Internal server error
* @returns {ErrorResponse} 403 - Forbidden
*/
routes.get(
'/user_permissions/:uuid',
(req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/user_permissions/:uuid')(req, res, next, config),
[
uuid('uuid').optional({ nullable: false, values: 'falsy' }),
uuid('fk_user').optional({ nullable: false, values: 'falsy' }),
uuid('fk_permission').optional({ nullable: false, values: 'falsy' })
],
(req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => getUserPermissionController(req, res, next, config),
(result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes),
(result, req, res, _) => sendOkResponse(result, req, res)
);
/**
* @name POST/user_permissions
* @function
* @inner
* @memberof deviceRouter
* @route POST /user_permissions
* @group User Permissions - Operations about user permissions
* @param {string} fk_user.path.required - The unique identifier for the user
* @param {string} fk_permission.path.required - The unique identifier for the permission
* @returns {SuccessResponse} 200 - User permission created successfully
* @returns {ErrorResponse} 400 - Bad request
* @returns {ErrorResponse} 404 - User permission not found
* @returns {ErrorResponse} 422 - Unprocessable entity
* @returns {ErrorResponse} 500 - Internal server error
* @returns {ErrorResponse} 403 - Forbidden
*/
routes.post(
'/user_permissions',
(req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/user_permissions')(req, res, next, config),
[
uuid('uuid').optional({ nullable: false, values: 'falsy' }),
uuid('fk_user').optional({ nullable: false, values: 'falsy' }),
uuid('fk_permission').optional({ nullable: false, values: 'falsy' })
],
(req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => postUserPermissionController(req, res, next, config),
(result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes),
(result, req, res, _) => sendCreatedResponse(result, req, res)
);
/**
* @name PUT/user_permissions/:uuid
* @function
* @inner
* @memberof deviceRouter
* @route PUT /user_permissions/{uuid}
* @group User Permissions - Operations about user permissions
* @param {string} uuid.path.required - The unique identifier for the user permission
* @param {string} fk_user.path.required - The unique identifier for the user
* @param {string} fk_permission.path.required - The unique identifier for the permission
* @returns {SuccessResponse} 200 - User permission updated successfully
* @returns {ErrorResponse} 400 - Bad request
* @returns {ErrorResponse} 404 - User permission not found
* @returns {ErrorResponse} 422 - Unprocessable entity
* @returns {ErrorResponse} 500 - Internal server error
* @returns {ErrorResponse} 403 - Forbidden
*/
routes.put(
'/user_permissions/:uuid',
(req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/user_permissions/:uuid')(req, res, next, config),
[
uuid('uuid').optional({ nullable: false, values: 'falsy' }),
uuid('fk_user').optional({ nullable: false, values: 'falsy' }),
uuid('fk_permission').optional({ nullable: false, values: 'falsy' })
],
(req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => putUserPermissionController(req, res, next, config),
(result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes),
(result, req, res, _) => sendCreatedResponse(result, req, res)
);
/**
* @name DELETE/user_permissions/:uuid
* @function
* @inner
* @memberof deviceRouter
* @route DELETE /user_permissions/{uuid}
* @group User Permissions - Operations about user permissions
* @param {string} uuid.path.required - The unique identifier for the user permission
* @param {string} fk_user.path.required - The unique identifier for the user
* @param {string} fk_permission.path.required - The unique identifier for the permission
* @returns {SuccessResponse} 200 - User permission deleted successfully
* @returns {ErrorResponse} 404 - User permission not found
* @returns {ErrorResponse} 422 - Unprocessable entity
* @returns {ErrorResponse} 500 - Internal server error
* @returns {ErrorResponse} 403 - Forbidden
* @returns {ErrorResponse} 401 - Unauthorized
* @returns {ErrorResponse} 400 - Bad request
*/
routes.delete(
'/user_permissions/:uuid',
(req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/user_permissions/:uuid')(req, res, next, config),
[
uuid('uuid').optional({ nullable: false, values: 'falsy' }),
uuid('fk_user').optional({ nullable: false, values: 'falsy' }),
uuid('fk_permission').optional({ nullable: false, values: 'falsy' })
],
(req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => softDeleteUserPermissionController(req, res, next, config),
(result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes),
(result, req, res, _) => sendResponseNoContent(result, req, res)
);
//Endpoints
routes.get(
'/endpoints',
(req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/endpoints')(req, res, next, config),
[
uuid('uuid').optional({ nullable: false, values: 'falsy' }),
varChar('route').optional({ nullable: false, values: 'falsy' })
],
(req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => getEndpointsController(req, res, next, config),
(result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes),
(result, req, res, _) => sendOkResponse(result, req, res)
);
routes.get(
'/endpoints/:uuid',
(req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/endpoints/:uuid')(req, res, next, config),
[
uuid('uuid').optional({ nullable: false, values: 'falsy' }),
varChar('name').optional({ nullable: false, values: 'falsy' })
],
(req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => getEndpointsController(req, res, next, config),
(result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes),
(result, req, res, _) => sendOkResponse(result, req, res)
);
routes.post(
'/endpoints',
(req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/endpoints')(req, res, next, config),
[
uuid('uuid').optional({ nullable: false, values: 'falsy' }),
varChar('route').optional({ nullable: false, values: 'falsy' })
],
(req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => postEndpointsController(req, res, next, config),
(result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes),
(result, req, res, _) => sendCreatedResponse(result, req, res)
);
routes.put(
'/endpoints/:uuid',
(req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/endpoints/:uuid')(req, res, next, config),
[
uuid('uuid').optional({ nullable: false, values: 'falsy' }),
varChar('route').optional({ nullable: false, values: 'falsy' })
],
(req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => putEndpointsController(req, res, next, config),
(result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes),
(result, req, res, _) => sendCreatedResponse(result, req, res)
);
routes.delete(
'/endpoints/:uuid',
(req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/endpoints/:uuid')(req, res, next, config),
[
uuid('uuid').optional({ nullable: false, values: 'falsy' }),
varChar('route').optional({ nullable: false, values: 'falsy' })
],
(req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => softDeleteEndpointsController(req, res, next, config),
(result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes),
(result, req, res, _) => sendResponseNoContent(result, req, res)
);
//roles_has_permissions routes
routes.get(
'/roles_has_permissions',
(req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/roles_has_permissions')(req, res, next, config),
[
uuid('uuid').optional({ nullable: false, values: 'falsy' }),
uuid('fk_role').optional({ nullable: false, values: 'falsy' }),
uuid('fk_permission').optional({ nullable: false, values: 'falsy' })
],
(req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => getRolesHasPermissionsController(req, res, next, config),
(result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes),
(result, req, res, _) => sendOkResponse(result, req, res)
);
routes.get(
'/roles_has_permissions/:uuid',
(req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/roles_has_permissions/:uuid')(req, res, next, config),
[
uuid('uuid').optional({ nullable: false, values: 'falsy' }),
uuid('fk_role').optional({ nullable: false, values: 'falsy' }),
uuid('fk_permission').optional({ nullable: false, values: 'falsy' })
],
(req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => getRolesHasPermissionsController(req, res, next, config),
(result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes),
(result, req, res, _) => sendOkResponse(result, req, res)
);
routes.post(
'/roles_has_permissions',
(req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/roles_has_permissions')(req, res, next, config),
[
uuid('uuid').optional({ nullable: false, values: 'falsy' }),
uuid('fk_role').optional({ nullable: false, values: 'falsy' }),
uuid('fk_permission').optional({ nullable: false, values: 'falsy' })
],
(req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => postRolesHasPermissionsController(req, res, next, config),
(result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes),
(result, req, res, _) => sendCreatedResponse(result, req, res)
);
routes.put(
'/roles_has_permissions/:uuid',
(req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/roles_has_permissions/:uuid')(req, res, next, config),
[
uuid('uuid').optional({ nullable: false, values: 'falsy' }),
uuid('fk_role').optional({ nullable: false, values: 'falsy' }),
uuid('fk_permission').optional({ nullable: false, values: 'falsy' })
],
(req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => putRolesHasPermissionsController(req, res, next, config),
(result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes),
(result, req, res, _) => sendCreatedResponse(result, req, res)
);
routes.delete(
'/roles_has_permissions/:uuid',
(req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => authorizePermission('/roles_has_permissions/:uuid')(req, res, next, config),
[
uuid('uuid').optional({ nullable: false, values: 'falsy' }),
uuid('fk_role').optional({ nullable: false, values: 'falsy' }),
uuid('fk_permission').optional({ nullable: false, values: 'falsy' })
],
(req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => softDeleteRolesHasPermissionsController(req, res, next, config),
(result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes),
(result, req, res, _) => sendResponseNoContent(result, req, res)
);
// Login Endpoint // Login Endpoint
/**
* @name POST/login
* @function
* @inner
* @memberof deviceRouter
* @route POST /login
* @group Login - Operations about login
* @param {string} username.path.required - The username of the user
* @param {string} password.path.required - The password of the user
* @returns {SuccessResponse} 200 - User logged in successfully
* @returns {ErrorResponse} 400 - Bad request
* @returns {ErrorResponse} 404 - User not found
* @returns {ErrorResponse} 422 - Unprocessable entity
* @returns {ErrorResponse} 500 - Internal server error
* @returns {ErrorResponse} 403 - Forbidden
*/
routes.post( routes.post(
'/login', '/login',
[ [
@ -259,5 +876,28 @@ export default(config) => {
(result, req, res, _) => sendLoginSuccessfullResponse(result, req, res) (result, req, res, _) => sendLoginSuccessfullResponse(result, req, res)
); );
routes.post(
'/refresh_token', //header contains refresh_token
(req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => authenticateToken(req, res, next, config),
(req, res, next) => postRefreshTokenController(req, res, next, config),
(result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes),
(result, req, res, _) => sendLoginSuccessfullResponse(result, req, res)
);
routes.post(
'/signin',
[
varChar('username').optional({ nullable: false, values: 'falsy' }),
varChar('password').optional({ nullable: false, values: 'falsy' }),
varChar('email').optional({ nullable: true, values: 'falsy' }),
varChar('fk_role').optional({ nullable: false, values: 'falsy' })
],
(req, res, next) => payloadExpressValidator(req, res, next, config),
(req, res, next) => postRegisterController(req, res, next, config),
(result, req, res, next) => addLinks(result, req, res, next, hasAddLinks, linkRoutes),
(result, req, res, _) => sendCreatedResponse(result, req, res)
);
return routes; return routes;
} }