feat(api-client): auto-generated js api-client sdk

.gitignore

@@ -1,6 +1,6 @@
 # compiled output
-/dist
-/node_modules
+dist
+node_modules
 data
 # Logs
 logs
@@ -51,4 +51,8 @@ dump.rdb
 tmp
 
 #eslint
-.eslintcache
+.eslintcache
+
+#nestia
+lib
+/api-client

apps/config-service/src/config-service.service.ts

@@ -18,6 +18,7 @@ import { DefaultConfigs } from './config.default';
 import { ConfigsInterface, ConfigsInterfaceKeys } from './config.interface';
 import { ConfigModel } from './config.model';
 import * as configDto from './config.dto';
+import { sleep } from 'zx-cjs';
 
 const allOptionKeys: Set<ConfigsInterfaceKeys> = new Set();
 const map: Record<string, any> = Object.entries(configDto).reduce(

apps/core/src/app.controller.ts

@@ -1,14 +1,7 @@
 import {
-  Body,
   Controller,
-  Delete,
   Get,
   Inject,
-  Param,
-  Patch,
-  Post,
-  Put,
-  Query,
 } from '@nestjs/common';
 import { AppService } from './app.service';
 import PKG from '../../../package.json';
@@ -55,45 +48,45 @@ export class AppController {
     );
   }
 
-  @Get('/*')
-  @ApiOperation({ summary: '自定义 Path (GET)' })
-  async customGetPath(@Query() query: any, @Param() param: any) {
-    return this.appService.transformCustomPath('GET', query, param);
-  }
+  // @Get('/*')
+  // @ApiOperation({ summary: '自定义 Path (GET)' })
+  // async customGetPath(@Query() query: any, @Param() param: any) {
+  //   return this.appService.transformCustomPath('GET', query, param);
+  // }
 
-  @Post('/*')
-  @ApiOperation({ summary: '自定义 Path (POST)' })
-  async customPostPath(
-    @Query() query: any,
-    @Param() param: any,
-    @Body() body: any,
-  ) {
-    return this.appService.transformCustomPath('POST', query, param, body);
-  }
+  // @Post('/*')
+  // @ApiOperation({ summary: '自定义 Path (POST)' })
+  // async customPostPath(
+  //   @Query() query: any,
+  //   @Param() param: any,
+  //   @Body() body: any,
+  // ) {
+  //   return this.appService.transformCustomPath('POST', query, param, body);
+  // }
 
-  @Put('/*')
-  @ApiOperation({ summary: '自定义 Path (PUT)' })
-  async customPutPath(
-    @Query() query: any,
-    @Param() param: any,
-    @Body() body: any,
-  ) {
-    return this.appService.transformCustomPath('PUT', query, param, body);
-  }
+  // @Put('/*')
+  // @ApiOperation({ summary: '自定义 Path (PUT)' })
+  // async customPutPath(
+  //   @Query() query: any,
+  //   @Param() param: any,
+  //   @Body() body: any,
+  // ) {
+  //   return this.appService.transformCustomPath('PUT', query, param, body);
+  // }
 
-  @Patch('/*')
-  @ApiOperation({ summary: '自定义 Path (PATCH)' })
-  async customPatchPath(
-    @Query() query: any,
-    @Param() param: any,
-    @Body() body: any,
-  ) {
-    return this.appService.transformCustomPath('PATCH', query, param, body);
-  }
+  // @Patch('/*')
+  // @ApiOperation({ summary: '自定义 Path (PATCH)' })
+  // async customPatchPath(
+  //   @Query() query: any,
+  //   @Param() param: any,
+  //   @Body() body: any,
+  // ) {
+  //   return this.appService.transformCustomPath('PATCH', query, param, body);
+  // }
 
-  @Delete('/*')
-  @ApiOperation({ summary: '自定义 Path (DELETE)' })
-  async customDeletePath(@Query() query: any, @Param() param: any) {
-    return this.appService.transformCustomPath('DELETE', query, param);
-  }
+  // @Delete('/*')
+  // @ApiOperation({ summary: '自定义 Path (DELETE)' })
+  // async customDeletePath(@Query() query: any, @Param() param: any) {
+  //   return this.appService.transformCustomPath('DELETE', query, param);
+  // }
 }

apps/core/src/app.service.ts

@@ -4,7 +4,7 @@ import { join } from 'path';
 import { cwd } from '@shared/global/env.global';
 import { ServicesEnum } from '~/shared/constants/services.constant';
 import { readFileSync } from 'fs';
-import { YAML } from 'zx-cjs';
+import { YAML, fs } from 'zx-cjs';
 import { transportReqToMicroservice } from '~/shared/microservice.transporter';
 
 interface IEventConfigItem {

apps/core/src/bootstrap.ts

@@ -18,6 +18,7 @@ import { isDev } from '@shared/global/env.global';
 import { consola } from '~/shared/global/consola.global';
 import { getEnv } from '~/shared/utils/rag-env';
 import { ServicesEnum } from '~/shared/constants/services.constant';
+import { argv, chalk } from 'zx-cjs';
 
 const Origin = CROSS_DOMAIN.allowedOrigins;
 

apps/core/src/modules/aggregate/aggregate.controller.ts

@@ -34,7 +34,11 @@ export class AggregateController {
   @ApiOperation({ summary: '获取概要' })
   @CacheKey(CacheKeys.AggregateCatch)
   @CacheTTL(300)
-  async aggregate() {
+  async aggregate(): Promise<{
+    categories: any;
+    pageMeta: any;
+    site: any;
+  }> {
     const tasks = await Promise.allSettled([
       // this.configService.getMaster(),
       this.aggregateService.getAllCategory(),
@@ -70,7 +74,12 @@ export class AggregateController {
   @ApiOperation({ summary: '获取网站sitemap' })
   @CacheKey(CacheKeys.SiteMapCatch)
   @CacheTTL(3600)
-  async getSiteMapContent() {
+  async getSiteMapContent(): Promise<{
+    data: {
+      url: URL;
+      published_at: Date;
+    }[];
+  }> {
     return { data: await this.aggregateService.getSiteMapContent() };
   }
 
@@ -84,8 +93,12 @@ export class AggregateController {
 
   @Get('/stat')
   @ApiOperation({ summary: '获取网站统计信息' })
-  // @Auth()
-  async stat() {
+  @Auth()
+  async stat(): Promise<{
+    posts: number;
+    pages: number;
+    categories: number;
+  }> {
     const [count] = await Promise.all([this.aggregateService.getCounts()]);
     return {
       ...count,

apps/core/src/modules/auth/auth.controller.ts

@@ -17,8 +17,6 @@ import {
   Query,
 } from '@nestjs/common';
 import { EventEmitter2 } from '@nestjs/event-emitter';
-
-import { MongoIdDto } from '~/shared/dto/id.dto';
 import { AuthService } from '~/libs/auth/src';
 import { Auth } from '~/shared/common/decorator/auth.decorator';
 import { ApiName } from '~/shared/common/decorator/openapi.decorator';
@@ -54,7 +52,11 @@ export class AuthController {
 
   @Post('token')
   @Auth()
-  async generateToken(@Body() body: TokenDto) {
+  async generateToken(@Body() body: TokenDto): Promise<{
+    expired: Date | undefined;
+    token: string;
+    name: string;
+  }> {
     const { expired, name } = body;
     const token = await this.authService.generateAccessToken();
     const model = {
@@ -67,8 +69,7 @@ export class AuthController {
   }
   @Delete('token')
   @Auth()
-  async deleteToken(@Query() query: MongoIdDto) {
-    const { id } = query;
+  async deleteToken(@Query('id') id: string) {
     const token = await this.authService
       .getAllAccessToken()
       .then((models) =>

apps/core/src/modules/category/category.controller.ts

@@ -26,7 +26,6 @@ import { ApiBody, ApiOperation, ApiParam, ApiQuery } from '@nestjs/swagger';
 import {
   MultiCategoriesQueryDto,
   MultiQueryTagAndCategoryDto,
-  SlugorIdDto,
 } from '~/apps/page-service/src/dto/category.dto';
 import {
   CategoryModel,
@@ -38,7 +37,6 @@ import { Auth } from '~/shared/common/decorator/auth.decorator';
 import { ApiName } from '~/shared/common/decorator/openapi.decorator';
 import { CategoryEvents } from '~/shared/constants/event.constant';
 import { ServicesEnum } from '~/shared/constants/services.constant';
-import { MongoIdDto } from '~/shared/dto/id.dto';
 import { transportReqToMicroservice } from '~/shared/microservice.transporter';
 
 @Controller('category')
@@ -87,9 +85,10 @@ export class CategoryController {
     required: false, // 是否必填
   })
   async getCategoryByCategoryIdOrTag(
-    @Param() { query }: SlugorIdDto,
-    @Query() { tag }: MultiQueryTagAndCategoryDto, // 如果这个是标签，则tag为true，如果是分类，则tag为分类id
+    @Query() _query: MultiQueryTagAndCategoryDto, // 如果这个是标签，则tag为true，如果是分类，则tag为分类id
+    @Param("query") query: string,
   ) {
+    const { tag } = _query;
     return transportReqToMicroservice<
       | {
           isTag: boolean;
@@ -104,7 +103,7 @@ export class CategoryController {
           };
           isTag: boolean;
         }
-    >(this.category, CategoryEvents.CategoryGet, { _query: query, _tag: tag });
+    >(this.category, CategoryEvents.CategoryGet, { query, _tag: tag });
   }
 
   @Post('/')
@@ -134,7 +133,7 @@ export class CategoryController {
   @ApiParam({ name: 'id', description: '分类id' })
   @ApiBody({ description: '分类信息', type: CategoryModel })
   async update(
-    @Param() { id }: MongoIdDto,
+    @Param("id") id: string,
     @Body() { type, slug, name }: CategoryModel,
   ) {
     const send = {
@@ -152,19 +151,19 @@ export class CategoryController {
   @ApiOperation({ summary: '更新分类' })
   @Auth()
   @HttpCode(204)
-  async patch(@Param() params: MongoIdDto, @Body() body: PartialCategoryModel) {
+  async patch(@Param("id") id: string, @Body() body: PartialCategoryModel) {
     return transportReqToMicroservice<CategoryModel>(
       this.category,
       CategoryEvents.CategoryPatch,
-      { _id: params.id, _data: body },
+      { _id: id, _data: body },
     );
   }
 
   @Delete('/:id')
   @ApiOperation({ summary: '删除分类' })
   @Auth()
   @ApiParam({ name: 'id', description: '分类id' })
-  async deleteCategory(@Param() { id }: MongoIdDto) {
+  async deleteCategory(@Param("id") id: string) {
     return transportReqToMicroservice<DeleteResult>(
       this.category,
       CategoryEvents.CategoryDelete,

apps/core/src/modules/console/console.controller.ts

@@ -15,7 +15,7 @@ export class ConsoleController {
     return true;
   }
 
-  @Get(['/*', '/'])
+  // @Get(['/*', '/'])
   async console(@Res() res: FastifyReply, @Req() req: FastifyRequest) {
     const path = req.url
       .replace('/console', '')

apps/core/src/modules/friends/friends.controller.ts

@@ -101,20 +101,20 @@ export class FriendsController {
   @ApiOperation({ summary: '更新友链' })
   async updateFriendStatus(
     @Param('id') id: string,
-    @Body('status') status: FriendStatus,
+    @Body() body: { status: FriendStatus },
   ) {
     return transportReqToMicroservice(
       this.friends,
       FriendsEvents.FriendPatchStatusByMaster,
-      { id, status },
+      { id, status: body.status },
     );
   }
 
   @Delete('/:id')
   @ApiOperation({ summary: '删除友链' })
   async deleteFriend(
     @Param('id') id: string,
-    @Body('token') token: string,
+    @Body() { token }: { token?: string },
     @IsMaster() isMaster: boolean,
   ) {
     return transportReqToMicroservice(

apps/core/src/modules/migrate/migrate.controller.ts

@@ -3,23 +3,37 @@ import { ApiOperation } from '@nestjs/swagger';
 import { MigrateService } from './migrate.service';
 import { MigrateData } from './migrate.interface';
 import { ApiName } from '~/shared/common/decorator/openapi.decorator';
+import { Auth } from '~/shared/common/decorator/auth.decorator';
+import { CategoryModel } from '~/apps/page-service/src/model/category.model';
 
 @Controller('migrate')
 @ApiName
 export class MigrateController {
   constructor(private readonly migrateService: MigrateService) {}
 
   @Post('import')
-  // @Auth()
+  @Auth()
   @ApiOperation({ summary: '使用 JSON 导入数据' })
-  async import(@Body() body: MigrateData) {
+  async import(@Body() body: MigrateData): Promise<{
+    user: any;
+    friends: any;
+    pages: any;
+    categories: never[] | CategoryModel[];
+    posts: any;
+    comments:
+      | never[]
+      | {
+          postError: string[];
+          parentError: string[];
+        };
+  }> {
     return await this.migrateService.import(body);
   }
 
   @Get('export')
-  // @Auth()
+  @Auth()
   @ApiOperation({ summary: '导出数据为 JSON' })
-  async export() {
+  async export(): Promise<any> {
     return await this.migrateService.export();
   }
 }

apps/core/src/modules/page/page.controller.ts

@@ -30,7 +30,6 @@ import { ApiName } from '~/shared/common/decorator/openapi.decorator';
 import { IsMaster } from '~/shared/common/decorator/role.decorator';
 import { PageEvents } from '~/shared/constants/event.constant';
 import { ServicesEnum } from '~/shared/constants/services.constant';
-import { MongoIdDto } from '~/shared/dto/id.dto';
 import { PagerDto } from '~/shared/dto/pager.dto';
 import { transportReqToMicroservice } from '~/shared/microservice.transporter';
 
@@ -86,21 +85,21 @@ export class PageController {
   @Patch('/:id')
   @ApiOperation({ summary: '更新页面' })
   @Auth()
-  async modify(@Body() body: PageModel, @Param() params: MongoIdDto) {
+  async modify(@Body() body: PageModel, @Param("id") id: string) {
     return transportReqToMicroservice(this.page, PageEvents.PagePatch, {
-      id: params.id,
+      id,
       body,
     });
   }
 
   @Delete('/:id')
   @ApiOperation({ summary: '删除页面' })
   @Auth()
-  async deletePage(@Param() params: MongoIdDto) {
+  async deletePage(@Param("id") id: string) {
     return transportReqToMicroservice(
       this.page,
       PageEvents.PageDelete,
-      params.id,
+      id,
     );
   }
 }