fix: add search function (#47)

package.json

@@ -25,6 +25,7 @@
     "@aws-sdk/client-s3": "^3.335.0",
     "@aws-sdk/s3-request-presigner": "^3.335.0",
     "@golevelup/nestjs-rabbitmq": "^3.6.0",
+    "@juicyllama/nestjs-redoc": "^2.3.10",
     "@nestjs/common": "^9.4.1",
     "@nestjs/config": "^2.3.2",
     "@nestjs/core": "^9.4.1",

src/common/utils/config/config.ts

@@ -4,4 +4,5 @@ export const config = {
   preSignedUrlExpiration: 60 * 60 * 24, // 24 hours
   jwtTokenExpiration: 60 * 60 * 24 * 7, // 7 days
   videoLockForSaleDuration: 1, // 30 minutes,
+  searchVideoLimit: 10, // number of videos returned when searching
 };

src/main.ts

@@ -1,9 +1,35 @@
 import { NestFactory } from '@nestjs/core';
 import { AppModule } from './app.module';
-import { config } from 'dotenv';
 import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
 import { ValidationPipe } from '@nestjs/common';
 import { AuthService } from './auth/auth.service';
+import { RedocModule, RedocOptions } from '@juicyllama/nestjs-redoc';
+
+/**
+ * This function will build the API document.
+ * You can check the documentation at path /docs.
+ * For example: `http://localhost:3000/docs`
+ * @returns {DocumentBuilder}
+ */
+function buildApiDocument() {
+  return new DocumentBuilder()
+    .setTitle('Video Trading server')
+    .setDescription('API for Api Trading server')
+    .addBearerAuth(
+      // defines the authentication type
+      // we have defined the permission role called `admin` in this example,
+      // and to use this admin tag, you can include `@ApiBearerAuth('admin')` in your controller
+      // and there will be an authentication section shown in the redoc document.
+      {
+        description: 'Regular user permission',
+        type: 'http',
+        name: 'user',
+      },
+      'user',
+    )
+    .setVersion('1.0')
+    .build();
+}
 
 async function bootstrap() {
   // Create the NestJS application.
@@ -23,30 +49,21 @@ async function bootstrap() {
   // make requests to our API
   app.enableCors();
 
-  // Setup swagger
-  // Swagger is a tool that helps us document our API
-  // It also provides a nice UI that we can use to test our API
-  const docConfig = new DocumentBuilder()
-    .setTitle('Video Trading API')
-    .setVersion('1.0')
-    .addTag('video')
-    .addTag('transcoding')
-    .addTag('playlist')
-    .addBearerAuth(
-      {
-        type: 'http',
-        scheme: 'bearer',
-        bearerFormat: 'JWT',
-        name: 'JWT',
-        description: 'Enter JWT token',
-        in: 'header',
-      },
-      'JWT-auth', // This name here is important for matching up with @ApiBearerAuth() in your controller!
-    )
-    .build();
+  // Creates the API document configuration object
+  const config = buildApiDocument();
+  // Creates the API document using the configuration object
+  const document = SwaggerModule.createDocument(app, config);
 
-  const document = SwaggerModule.createDocument(app, docConfig);
-  SwaggerModule.setup('api', app, document);
+  // Setups the redoc document
+  const redocOptions: RedocOptions = {
+    // These options are from the redoc document.
+    // More info: https://github.com/Redocly/redoc
+    sortPropsAlphabetically: true,
+    hideDownloadButton: true,
+    hideHostname: false,
+  };
+  // Defines the path where the redoc document will be available
+  await RedocModule.setup('/docs', app, document, redocOptions);
 
   // get auth token from mondule
 

src/video/dto/list-video.dto.ts

@@ -0,0 +1 @@
+export class ListVideoDto {}

src/video/dto/search-video.dto.ts

@@ -0,0 +1,13 @@
+import { IsString } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+
+export class SearchVideoResponse {
+  @ApiProperty()
+  id: string;
+
+  @ApiProperty()
+  title: string;
+
+  @ApiProperty()
+  thumbnail: string;
+}

src/video/video.controller.ts

@@ -44,6 +44,7 @@ import { PublishVideoDto } from './dto/publish-video.dto';
 import { UpdateVideoDto } from './dto/update-video.dto';
 import { VideoService } from './video.service';
 import { Environments } from '../common/environment';
+import { SearchVideoResponse } from './dto/search-video.dto';
 
 @Controller('video')
 @ApiTags('video')
@@ -318,4 +319,12 @@ export class VideoController {
   ) {
     return await this.videoService.findMyVideoDetailById(id, req.user.userId);
   }
+
+  @Get('search/:keyword')
+  @ApiOkResponse({
+    description: 'Search videos by keyword',
+  })
+  async searchVideos(@Param('keyword') keyword: string) {
+    return await this.videoService.searchVideos(keyword);
+  }
 }