fix: add shuffle query endpoint for retrieving channel items by season

Author: mitchdowney

src/controllers/item.ts

@@ -83,6 +83,11 @@ const getManyByChannelBySeasonQuerySchema = Joi.object({
   page: Joi.number().integer().min(1).required()
 });
 
+const getManyByChannelBySeasonShuffleQuerySchema = Joi.object({
+  page: Joi.number().integer().min(1).required(),
+  shuffleHash: Joi.string().required()
+});
+
 const getManyByChannelTopQuerySchema = Joi.object({
   range: Joi.string().valid(...QUERY_PARAMS_STATS_RANGE_VALUES).required(),
   page: Joi.number().integer().min(1).required()
@@ -566,6 +571,38 @@ export class ItemController {
     });
   }
 
+  static async getManyByChannelBySeasonShuffle(req: Request, res: Response): Promise<void> {
+    validateParamsObject(getManyByChannelParmsSchema, req, res, async () => {
+      validateQueryObject(getManyByChannelBySeasonShuffleQuerySchema, req, res, async () => {
+        try {
+          const { page, limit, offset } = getPaginationParams(req);
+          const { channelIdOrIdText } = req.params;
+          const { shuffleHash } = req.query as { shuffleHash: string };
+
+          const channel = await ItemController.channelService.getByIdOrIdText(
+            channelIdOrIdText,
+            { channel_about: true }
+          );
+
+          if (!channel) {
+            res.status(404).json({ message: 'Channel not found' });
+            return;
+          }
+
+          const config: FindManyOptions<Item> = {
+            skip: offset,
+            take: limit
+          };
+          const items = await ItemController.itemService.getManyByChannelBySeason(channel, "shuffle", config, shuffleHash);
+
+          res.json({ data: items, meta: { page, count: channel.channel_about.episode_count, limit } });
+        } catch (error) {
+          handleGenericErrorResponse(res, error);
+        }
+      });
+    });
+  }
+
   static async getManyForQueueByPubDate(req: Request, res: Response): Promise<void> {
     validateParamsObject(getManyForQueueByPubDateParamsSchema, req, res, async () => {
       validateQueryObject(getManyForQueueByPubDateQuerySchema, req, res, async () => {

src/routes/item.ts

@@ -11,6 +11,7 @@ router.get('/chapters/:item_id_text', asyncHandler(ItemController.parseAndGetCha
 
 router.get('/channel/season/forward/:channelIdOrIdText', asyncHandler(ItemController.getManyByChannelBySeasonForward));
 router.get('/channel/season/backward/:channelIdOrIdText', asyncHandler(ItemController.getManyByChannelBySeasonBackward));
+router.get('/channel/season/shuffle/:channelIdOrIdText', asyncHandler(ItemController.getManyByChannelBySeasonShuffle));
 
 router.get('/channel/recent/:channelIdOrIdText', asyncHandler(ItemController.getManyByChannelRecent));
 router.get('/channel/oldest/:channelIdOrIdText', asyncHandler(ItemController.getManyByChannelOldest));