fix: task stats api

GopeedLab · Aug 20, 2024 · 873c8a7 · 873c8a7
1 parent bb4da4f
commit 873c8a7
Show file tree

Hide file tree

Showing 9 changed files with 46 additions and 12 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "private": true,
-  "version": "1.5.0",
+  "version": "1.5.1",
   "type": "module",
   "scripts": {
     "build": "rollup -c",

diff --git a/packages/create-gopeed-ext/package.json b/packages/create-gopeed-ext/package.json
@@ -1,6 +1,6 @@
 {
   "name": "create-gopeed-ext",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "keywords": [
     "gopeed"
   ],

diff --git a/packages/create-gopeed-ext/templates/webpack/package.json b/packages/create-gopeed-ext/templates/webpack/package.json
@@ -20,7 +20,7 @@
     "eslint": "^8.51.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-prettier": "^5.0.0",
-    "gopeed": "^1.5.0",
+    "gopeed": "^1.5.1",
     "gopeed-polyfill-webpack-plugin": "^1.0.6",
     "prettier": "^3.0.3",
     "webpack": "^5.75.0",

diff --git a/packages/gopeed-openapi/src/v1/TaskController.ts b/packages/gopeed-openapi/src/v1/TaskController.ts
@@ -7,6 +7,7 @@ import {
   TaskStatus,
   CreateTaskBatch,
   Result,
+  TaskStats,
 } from '@gopeed/types';
 import { Body, Controller, Delete, Get, Path, Post, Put, Query, Route, Security, SuccessResponse } from 'tsoa';
 
@@ -57,14 +58,14 @@ export class UsersController extends Controller {
   }
 
   /**
-   * Get task download status detail info
+   * Get task stats
    * @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>;
+  public async stats(@Path() id: string): Promise<Result<TaskStats>> {
+    return null as unknown as Result<TaskStats>;
   }
 
   /**

diff --git a/packages/gopeed-rest/package.json b/packages/gopeed-rest/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@gopeed/rest",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "",
   "main": "dist/index.js",
   "exports": {

diff --git a/packages/gopeed-rest/src/index.ts b/packages/gopeed-rest/src/index.ts
@@ -1,11 +1,14 @@
 import type {
   Result,
   Request,
+  ResolveResult,
   CreateTaskWithRequest,
   CreateTaskWithResolveResult,
-  ResolveResult,
+  CreateTaskBatch,
   Task,
   TaskStatus,
+  TaskBtStats,
+  TaskStats,
 } from '@gopeed/types';
 
 interface ClientOptions {
@@ -53,6 +56,17 @@ class Client {
     });
   }
 
+  /**
+   * Create a batch of download tasks
+   * @param request - The request to create a batch of download tasks
+   * @returns
+   */
+  public async createTaskBatch(request: CreateTaskBatch): Promise<string[]> {
+    return this.doRequest<string[]>('POST', '/api/v1/tasks/batch', {
+      data: request,
+    });
+  }
+
   /**
    * Get task info
    * @param id - Task id
@@ -75,6 +89,15 @@ class Client {
     });
   }
 
+  /**
+   * Get task stats
+   * @param id - Task id
+   * @returns
+   */
+  public async getTaskStats(id: string): Promise<TaskStats> {
+    return this.doRequest<TaskBtStats>('GET', `/api/v1/tasks/${id}/stats`);
+  }
+
   /**
    * Pause a task
    * @param id - Task id

diff --git a/packages/gopeed-types/package.json b/packages/gopeed-types/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@gopeed/types",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "",
   "main": "dist/index.js",
   "exports": {

diff --git a/packages/gopeed-types/src/index.ts b/packages/gopeed-types/src/index.ts
@@ -82,6 +82,8 @@ export interface BtReqExtra {
   trackers?: string[];
 }
 
+export type ReqExtra = HttpReqExtra | BtReqExtra;
+
 /**
  * HTTP download extra options
  * @example {
@@ -93,8 +95,14 @@ export interface HttpOptExtra {
    * Concurrent connections
    */
   connections?: number;
+  /**
+   * When task download complete, and it is a .torrent file, it will be auto create a new task for the torrent file
+   */
+  autoTorrent?: boolean;
 }
 
+export type OptExtra = HttpOptExtra;
+
 /**
  * Download request
  * @example {
@@ -109,7 +117,7 @@ export interface Request {
   /**
    * Extra request options
    */
-  extra?: HttpReqExtra | BtReqExtra;
+  extra?: ReqExtra;
   /**
    * Request labels
    */
@@ -190,7 +198,7 @@ export interface Options {
   /**
    * Download extra options
    */
-  extra?: HttpOptExtra;
+  extra?: OptExtra;
 }
 
 export type Protocol = 'http' | 'bt';
@@ -295,6 +303,8 @@ export interface TaskBtStats {
   seedTime: number;
 }
 
+export type TaskStats = TaskBtStats;
+
 export interface CreateTaskWithResolveResult {
   /**
    * Resolved id, from resolved result

diff --git a/packages/gopeed/package.json b/packages/gopeed/package.json
@@ -1,6 +1,6 @@
 {
   "name": "gopeed",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "",
   "main": "index.js",
   "type": "module",