feat: update models

package.json

@@ -1,6 +1,6 @@
 {
   "private": true,
-  "version": "1.4.2",
+  "version": "1.5.0",
   "type": "module",
   "scripts": {
     "build": "rollup -c",

packages/create-gopeed-ext/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-gopeed-ext",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "keywords": [
     "gopeed"
   ],

packages/create-gopeed-ext/templates/webpack/package.json

@@ -20,8 +20,8 @@
     "eslint": "^8.51.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-prettier": "^5.0.0",
-    "gopeed": "^1.4.2",
-    "gopeed-polyfill-webpack-plugin": "^1.0.5",
+    "gopeed": "^1.5.0",
+    "gopeed-polyfill-webpack-plugin": "^1.0.6",
     "prettier": "^3.0.3",
     "webpack": "^5.75.0",
     "webpack-cli": "^5.0.1"

packages/gopeed-openapi/src/v1/IndexController.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 /* eslint-disable no-unused-vars */
-import { ServerInfo } from '@gopeed/types';
+import { Result, ServerInfo } from '@gopeed/types';
 import { Controller, Get, Route, Security } from 'tsoa';
 
 @Route('/api/v1')
@@ -11,7 +11,7 @@ export class UsersController extends Controller {
    */
   @Security('X-Api-Token')
   @Get('/info')
-  public async info(): Promise<ServerInfo> {
-    return null as unknown as ServerInfo;
+  public async info(): Promise<Result<ServerInfo>> {
+    return null as unknown as Result<ServerInfo>;
   }
 }

packages/gopeed-openapi/src/v1/ResolveController.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 /* eslint-disable no-unused-vars */
-import { Request, ResolveResult } from '@gopeed/types';
+import { Request, ResolveResult, Result } from '@gopeed/types';
 import { Body, Controller, Post, Route, Security } from 'tsoa';
 
 @Route('/api/v1/resolve')
@@ -11,7 +11,7 @@ export class UsersController extends Controller {
    */
   @Security('X-Api-Token')
   @Post()
-  public async resolve(@Body() req: Request): Promise<ResolveResult> {
-    return null as unknown as ResolveResult;
+  public async resolve(@Body() req: Request): Promise<Result<ResolveResult>> {
+    return null as unknown as Result<ResolveResult>;
   }
 }

packages/gopeed-openapi/src/v1/TaskController.ts

@@ -1,6 +1,13 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 /* eslint-disable no-unused-vars */
-import { CreateTaskWithRequest, CreateTaskWithResolveResult, Task, TaskStatus, CreateTaskBatch } from '@gopeed/types';
+import {
+  CreateTaskWithRequest,
+  CreateTaskWithResolveResult,
+  Task,
+  TaskStatus,
+  CreateTaskBatch,
+  Result,
+} from '@gopeed/types';
 import { Body, Controller, Delete, Get, Path, Post, Put, Query, Route, Security, SuccessResponse } from 'tsoa';
 
 @Route('/api/v1/tasks')
@@ -13,8 +20,8 @@ export class UsersController extends Controller {
    */
   @Security('X-Api-Token')
   @Post()
-  public async createTask(@Body() req: CreateTaskWithResolveResult | CreateTaskWithRequest): Promise<string> {
-    return null as unknown as string;
+  public async createTask(@Body() req: CreateTaskWithResolveResult | CreateTaskWithRequest): Promise<Result<string>> {
+    return null as unknown as Result<string>;
   }
 
   /**
@@ -23,8 +30,8 @@ export class UsersController extends Controller {
    */
   @Security('X-Api-Token')
   @Post('/batch')
-  public async createTaskBatch(@Body() req: CreateTaskBatch): Promise<string[]> {
-    return null as unknown as string[];
+  public async createTaskBatch(@Body() req: CreateTaskBatch): Promise<Result<string[]>> {
+    return null as unknown as Result<string[]>;
   }
 
   /**
@@ -34,8 +41,8 @@ export class UsersController extends Controller {
    */
   @Security('X-Api-Token')
   @Get('{id}')
-  public async getTask(@Path() id: string): Promise<Task> {
-    return null as unknown as Task;
+  public async getTask(@Path() id: string): Promise<Result<Task>> {
+    return null as unknown as Result<Task>;
   }
 
   /**
@@ -45,8 +52,19 @@ export class UsersController extends Controller {
    */
   @Security('X-Api-Token')
   @Get()
-  public async getTasks(@Query() status: TaskStatus[] = []): Promise<Task[]> {
-    return null as unknown as Task[];
+  public async getTasks(@Query() status: TaskStatus[] = []): Promise<Result<Task[]>> {
+    return null as unknown as Result<Task[]>;
+  }
+
+  /**
+   * Get task download status detail info
+   * @param id - Task id
+   * @returns
+   */
+  @Security('X-Api-Token')
+  @Get('{id}/stats')
+  public async stats(@Path() id: string): Promise<Result<Task>> {
+    return null as unknown as Result<Task>;
   }
 
   /**
@@ -57,8 +75,8 @@ export class UsersController extends Controller {
   @Security('X-Api-Token')
   @Put('{id}/pause')
   @SuccessResponse(200)
-  public async pauseTask(@Path() id: string): Promise<void> {
-    return null as unknown as void;
+  public async pauseTask(@Path() id: string): Promise<Result<void>> {
+    return null as unknown as Result<void>;
   }
 
   /**
@@ -69,8 +87,8 @@ export class UsersController extends Controller {
   @Security('X-Api-Token')
   @Put('{id}/continue')
   @SuccessResponse(200)
-  public async continueTask(@Path() id: string): Promise<void> {
-    return null as unknown as void;
+  public async continueTask(@Path() id: string): Promise<Result<void>> {
+    return null as unknown as Result<void>;
   }
 
   /**
@@ -80,8 +98,8 @@ export class UsersController extends Controller {
   @Security('X-Api-Token')
   @Put('pause')
   @SuccessResponse(200)
-  public async pauseAllTasks(): Promise<void> {
-    return;
+  public async pauseAllTasks(): Promise<Result<void>> {
+    return null as unknown as Result<void>;
   }
 
   /**
@@ -91,8 +109,8 @@ export class UsersController extends Controller {
   @Security('X-Api-Token')
   @Put('continue')
   @SuccessResponse(200)
-  public async continueAllTasks(): Promise<void> {
-    return;
+  public async continueAllTasks(): Promise<Result<void>> {
+    return null as unknown as Result<void>;
   }
 
   /**
@@ -104,8 +122,8 @@ export class UsersController extends Controller {
   @Security('X-Api-Token')
   @Delete('{id}')
   @SuccessResponse(200)
-  public async deleteTask(@Path() id: string, @Query() force = false): Promise<void> {
-    return;
+  public async deleteTask(@Path() id: string, @Query() force = false): Promise<Result<void>> {
+    return null as unknown as Result<void>;
   }
 
   /**
@@ -117,7 +135,7 @@ export class UsersController extends Controller {
   @Security('X-Api-Token')
   @Delete()
   @SuccessResponse(200)
-  public async deleteTasks(@Query() status: TaskStatus[] = [], @Query() force = false): Promise<void> {
-    return;
+  public async deleteTasks(@Query() status: TaskStatus[] = [], @Query() force = false): Promise<Result<void>> {
+    return null as unknown as Result<void>;
   }
 }

packages/gopeed-rest/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gopeed/rest",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "description": "",
   "main": "dist/index.js",
   "exports": {

packages/gopeed-rest/src/index.ts

@@ -1,4 +1,5 @@
 import type {
+  Result,
   Request,
   CreateTaskWithRequest,
   CreateTaskWithResolveResult,
@@ -12,12 +13,6 @@ interface ClientOptions {
   token: string;
 }
 
-interface Result<T> {
-  code: number;
-  msg: string;
-  data: T;
-}
-
 class ApiError extends Error {
   code: number;
   msg: string;

packages/gopeed-types/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gopeed/types",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "description": "",
   "main": "dist/index.js",
   "exports": {

packages/gopeed-types/src/index.ts

@@ -1,6 +1,24 @@
 export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS' | 'CONNECT' | 'TRACE';
 export type HttpHeader = { [key: string]: string };
 
+/**
+ * REST API result
+ */
+export interface Result<T> {
+  /**
+   * The response code, `0` means success, other values means error.
+   */
+  code: number;
+  /**
+   * The response message, if `code` != `0`, this field will contain error message.
+   */
+  msg: string;
+  /**
+   * The response data, if `code` == `0`, this field will contain response data.
+   */
+  data: T;
+}
+
 /**
  * Server info
  */
@@ -119,7 +137,6 @@ export interface FileInfo {
    * File size(byte)
    */
   size: number;
-
   /**
    * Specify the request for this file
    */
@@ -176,6 +193,8 @@ export interface Options {
   extra?: HttpOptExtra;
 }
 
+export type Protocol = 'http' | 'bt';
+
 export type TaskStatus = 'ready' | 'running' | 'pause' | 'wait' | 'error' | 'done';
 
 export interface TaskProgress {
@@ -191,13 +210,25 @@ export interface TaskProgress {
    * Downloaded size(byte)
    */
   downloaded: number;
+  /**
+   * Uploaded speed(bytes/s)
+   */
+  uploadSpeed: number;
+  /**
+   * Uploaded size(bytes)
+   */
+  uploaded: number;
 }
 
 export interface Task {
   /**
    * Task id
    */
   id: string;
+  /**
+   * Protocol type
+   */
+  protocol: Protocol;
   /**
    * Task metadata
    */
@@ -212,6 +243,10 @@ export interface Task {
    * @example "running"
    */
   status: TaskStatus;
+  /**
+   * Task is uploading
+   */
+  uploading: boolean;
   /**
    * Task progress
    */
@@ -232,6 +267,34 @@ export interface Task {
   updatedAt: string;
 }
 
+export interface TaskBtStats {
+  /**
+   * Total peers
+   */
+  totalPeers: number;
+  /**
+   * Active peers
+   */
+  activePeers: number;
+  /**
+   * Connected seeders
+   */
+  connectedSeeders: number;
+  /**
+   * Total seed bytes
+   */
+  seedBytes: number;
+  /**
+   * Seed ratio
+   * @example 0.1
+   */
+  seedRatio: number;
+  /**
+   * Total seed time(s)
+   */
+  seedTime: number;
+}
+
 export interface CreateTaskWithResolveResult {
   /**
    * Resolved id, from resolved result

packages/gopeed/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gopeed",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "description": "",
   "main": "index.js",
   "type": "module",