user.routes.ts

import { Router } from "express";

import * as userController from "../controllers/userController";
import { isPioneerFound } from "../middlewares/isPioneerFound";
import { verifyToken } from "../middlewares/verifyToken";

/**
 * @swagger
 * components:
 *   schemas:
 *     UserSchema:
 *       type: object
 *       properties:
 *         pi_uid:
 *           type: string
 *           description: Pi user ID
 *         pi_username:
 *           type: string
 *           description: Pi user alias
 *         user_name:
 *           type: string
 *           description: Name of Pi user; preset to Pi user alias
 */
const userRoutes = Router();

/**
 * @swagger
 * /api/v1/users/authenticate:
 *   post:
 *     tags:
 *       - User
 *     summary: Authenticate the user's access token *
 *     security:
 *       - BearerAuth: []     
 *     responses:
 *       200:
 *         description: Successful response
 *         content:
 *           application/json:
 *             schema:
 *               $ref: '/api/docs/UsersSchema.yml#/components/schemas/AuthenticateUserRs'
 *       404:
 *         description: Pioneer not found
 *       400:
 *         description: Bad request
 *       500:
 *         description: Internal server error
 */
userRoutes.post("/authenticate", isPioneerFound, userController.authenticateUser);

/**
 * @swagger
 * /api/v1/users/me:
 *   get:
 *     tags:
 *       - User
 *     summary: Fetch the user's information using Bearer Auth token *
 *     responses:
 *       200:
 *         description: Successful response
 *         content:
 *           application/json:
 *             schema:
 *               $ref: '/api/docs/UsersSchema.yml#/components/schemas/GetUserRs'
 *       404:
 *         description: User not found | Pioneer not found
 *       401:
 *         description: Unauthorized
 *       400:
 *         description: Bad request
 *       500:
 *         description: Internal server error
 */  
userRoutes.get("/me", verifyToken, userController.autoLoginUser); 

/**
 * @swagger
 * /api/v1/users/{pi_uid}:
 *   get:
 *     tags:
 *       - User
 *     summary: Get a user by Pi UID
 *     parameters:
 *       - name: pi_uid
 *         in: path
 *         required: true
 *         schema:
 *           type: string
 *         description: The Pi uid of the user to retrieve
 *     responses:
 *       200:
 *         description: Successful response
 *         content:
 *           application/json:
 *             schema:
 *               $ref: '/api/docs/UsersSchema.yml#/components/schemas/GetUserRs'
 *       404:
 *         description: User not found
 *       400:
 *         description: Bad request
 *       500:
 *         description: Internal server error
 */
userRoutes.get("/:pi_uid", userController.getUser);

/**
 * @swagger
 * /api/v1/users/delete:
 *   delete:
 *     tags:
 *       - User
 *     summary: Delete a user and user associated data using Bearer Auth token *
 *     responses:
 *       200:
 *         description: Successful response | User deleted successfully
 *         content:
 *           application/json:
 *             schema:
 *               $ref: '/api/docs/UsersSchema.yml#/components/schemas/DeleteUserRs'
 *       404:
 *         description: User not found
 *       401:
 *         description: Unauthorized
 *       400:
 *         description: Bad request
 *       500:
 *         description: Internal server error
 */
userRoutes.delete(
  "/delete",
  verifyToken,
  userController.deleteUser
);

export default userRoutes;