botasaurus-desktop-api 4.1.85 → 4.1.87

package/dist/bundle.js

@@ -2864,11 +2864,11 @@ function cleanBasePath(apiBasePath) {
 }
 class Api {
     _writeJson(filename, data) {
-        /**
-         * Writes data to a JSON file specified by the filename. This method only runs if the createResponseFiles flag is True.
-         *
-         * @param filename The filename for the JSON file to be created.
-         * @param data The data to be written to the file.
+        /**
+         * Writes data to a JSON file specified by the filename. This method only runs if the createResponseFiles flag is True.
+         *
+         * @param filename The filename for the JSON file to be created.
+         * @param data The data to be written to the file.
          */ if (this._createResponseFiles) {
             const path = _createFilename(filename);
             (0,_utils__WEBPACK_IMPORTED_MODULE_0__.writeJsonResponse)(path, data);
@@ -2878,11 +2878,16 @@ class Api {
     _makeApiUrl(path) {
         return `${this._apiUrl}${this._apiBasePath}${path === '' && this._apiBasePath ? "" : "/"}${path}`;
     }
+    _getCacheParams() {
+        return typeof this._enableCache === 'boolean' ? {
+            enable_cache: this._enableCache
+        } : {};
+    }
     async isApiRunning() {
-        /**
-         * Checks if the API is running by performing a health check on the "/api" endpoint.
-         *
-         * @return True if the health check is successful, otherwise False.
+        /**
+         * Checks if the API is running by performing a health check on the "/api" endpoint.
+         *
+         * @return True if the health check is successful, otherwise False.
          */ try {
             const response = await axios__WEBPACK_IMPORTED_MODULE_1__["default"].get(this._makeApiUrl(""));
             return response.status === 200;
@@ -2897,16 +2902,17 @@ const api = new Api({ apiUrl: 'https://example.com' })`);
     }
     async createAsyncTask(param) {
         let { data, scraperName } = param;
-        /**
-         * Submits an asynchronous task to the server.
-         *
-         * @param data The data to be received by the scraper.
-         * @param scraperName The name of the scraper to use for the task. If not provided, the server will use the default scraper.
-         * @return The created task object.
+        /**
+         * Submits an asynchronous task to the server.
+         *
+         * @param data The data to be received by the scraper.
+         * @param scraperName The name of the scraper to use for the task. If not provided, the server will use the default scraper.
+         * @return The created task object.
          */ const url = this._makeApiUrl("tasks/create-task-async");
         const payload = {
             data,
-            scraper_name: scraperName
+            scraper_name: scraperName,
+            ...this._getCacheParams()
         };
         try {
             const response = await axios__WEBPACK_IMPORTED_MODULE_1__["default"].post(url, payload);
@@ -2921,16 +2927,17 @@ const api = new Api({ apiUrl: 'https://example.com' })`);
     }
     async createSyncTask(param) {
         let { data, scraperName } = param;
-        /**
-         * Submits a synchronous task to the server.
-         *
-         * @param data The data to be received by the scraper.
-         * @param scraperName The name of the scraper to use for the task. If not provided, the server will use the default scraper.
-         * @return The created task object.
+        /**
+         * Submits a synchronous task to the server.
+         *
+         * @param data The data to be received by the scraper.
+         * @param scraperName The name of the scraper to use for the task. If not provided, the server will use the default scraper.
+         * @return The created task object.
          */ const url = this._makeApiUrl("tasks/create-task-sync");
         const payload = {
             data,
-            scraper_name: scraperName
+            scraper_name: scraperName,
+            ...this._getCacheParams()
         };
         try {
             const response = await axios__WEBPACK_IMPORTED_MODULE_1__["default"].post(url, payload);
@@ -2945,16 +2952,17 @@ const api = new Api({ apiUrl: 'https://example.com' })`);
     }
     async createAsyncTasks(param) {
         let { dataItems, scraperName } = param;
-        /**
-         * Submits multiple asynchronous tasks to the server in a batch.
-         *
-         * @param dataItems A list of data items to be processed by the scraper.
-         * @param scraperName The name of the scraper to use for the tasks. If not provided, the server will use the default scraper.
-         * @return A list of created task objects.
+        /**
+         * Submits multiple asynchronous tasks to the server in a batch.
+         *
+         * @param dataItems A list of data items to be processed by the scraper.
+         * @param scraperName The name of the scraper to use for the tasks. If not provided, the server will use the default scraper.
+         * @return A list of created task objects.
          */ const url = this._makeApiUrl("tasks/create-task-async");
         const payload = dataItems.map((data)=>({
                 data,
-                scraper_name: scraperName
+                scraper_name: scraperName,
+                ...this._getCacheParams()
             }));
         try {
             const response = await axios__WEBPACK_IMPORTED_MODULE_1__["default"].post(url, payload);
@@ -2969,16 +2977,17 @@ const api = new Api({ apiUrl: 'https://example.com' })`);
     }
     async createSyncTasks(param) {
         let { dataItems, scraperName } = param;
-        /**
-         * Submits multiple synchronous tasks to the server in a batch and waits for the results.
-         *
-         * @param dataItems A list of data items to be processed by the scraper.
-         * @param scraperName The name of the scraper to use for the tasks. If not provided, the server will use the default scraper.
-         * @return A list of created task objects, each with its processing result.
+        /**
+         * Submits multiple synchronous tasks to the server in a batch and waits for the results.
+         *
+         * @param dataItems A list of data items to be processed by the scraper.
+         * @param scraperName The name of the scraper to use for the tasks. If not provided, the server will use the default scraper.
+         * @return A list of created task objects, each with its processing result.
          */ const url = this._makeApiUrl("tasks/create-task-sync");
         const payload = dataItems.map((data)=>({
                 data,
-                scraper_name: scraperName
+                scraper_name: scraperName,
+                ...this._getCacheParams()
             }));
         try {
             const response = await axios__WEBPACK_IMPORTED_MODULE_1__["default"].post(url, payload);
@@ -2996,13 +3005,13 @@ const api = new Api({ apiUrl: 'https://example.com' })`);
             page: 1,
             withResults: true
         };
-        /**
-         * Fetches tasks from the server, with optional result inclusion, pagination, and filtering.
-         *
-         * @param page The page number for pagination.
-         * @param perPage The number of tasks to return per page.
-         * @param withResults Whether to include the task results in the response.
-         * @return A dictionary containing the task results and pagination information.
+        /**
+         * Fetches tasks from the server, with optional result inclusion, pagination, and filtering.
+         *
+         * @param page The page number for pagination.
+         * @param perPage The number of tasks to return per page.
+         * @param withResults Whether to include the task results in the response.
+         * @return A dictionary containing the task results and pagination information.
          */ const url = this._makeApiUrl("tasks");
         const params = {
             with_results: withResults
@@ -3030,11 +3039,11 @@ const api = new Api({ apiUrl: 'https://example.com' })`);
         }
     }
     async getTask(taskId) {
-        /**
-         * Retrieves a specific task by ID.
-         *
-         * @param taskId The ID of the task to retrieve.
-         * @return The task object.
+        /**
+         * Retrieves a specific task by ID.
+         *
+         * @param taskId The ID of the task to retrieve.
+         * @return The task object.
          */ const url = this._makeApiUrl(`tasks/${taskId}`);
         try {
             const response = await axios__WEBPACK_IMPORTED_MODULE_1__["default"].get(url);
@@ -3049,16 +3058,16 @@ const api = new Api({ apiUrl: 'https://example.com' })`);
     }
     async getTaskResults(param) {
         let { taskId, filters, sort, view, page = 1, perPage } = param;
-        /**
-         * Retrieves the results of a specific task.
-         *
-         * @param taskId The ID of the task.
-         * @param filters A dictionary of filters to apply to the task results, optional.
-         * @param sort The sort to apply to the task results, optional.
-         * @param view The view to apply to the task results, optional.
-         * @param page The page number to retrieve, default is 1.
-         * @param perPage The number of results to return per page. If perPage is not provided, all results are returned, optional.
-         * @return A dictionary containing the task results and pagination information if page and perPage are provided.
+        /**
+         * Retrieves the results of a specific task.
+         *
+         * @param taskId The ID of the task.
+         * @param filters A dictionary of filters to apply to the task results, optional.
+         * @param sort The sort to apply to the task results, optional.
+         * @param view The view to apply to the task results, optional.
+         * @param page The page number to retrieve, default is 1.
+         * @param perPage The number of results to return per page. If perPage is not provided, all results are returned, optional.
+         * @return A dictionary containing the task results and pagination information if page and perPage are provided.
          */ const url = this._makeApiUrl(`tasks/${taskId}/results`);
         const payload = {
             page
@@ -3086,19 +3095,23 @@ const api = new Api({ apiUrl: 'https://example.com' })`);
         }
     }
     async get(scraperName, data) {
-        /**
-         * Makes a direct GET request to the scraper endpoint, bypassing the task creating and scheduling system.
-         *
-         * @param scraperName The name of the scraper, which corresponds to the route path (e.g., "scrape-heading-task").
-         * @param data The data to be received by the scraper.
-         * @return The result from the scraper.
+        /**
+         * Makes a direct GET request to the scraper endpoint, bypassing the task creating and scheduling system.
+         *
+         * @param scraperName The name of the scraper, which corresponds to the route path (e.g., "scrape-heading-task").
+         * @param data The data to be received by the scraper.
+         * @return The result from the scraper.
          */ if (scraperName.startsWith('/')) {
             scraperName = scraperName.slice(1);
         }
         const url = this._makeApiUrl(scraperName);
+        const params = {
+            ...data,
+            ...this._getCacheParams()
+        };
         try {
             const response = await axios__WEBPACK_IMPORTED_MODULE_1__["default"].get(url, {
-                params: data
+                params
             });
             const fileScraperName = scraperName.replaceAll('/', '-');
             this._writeJson(`${fileScraperName}-result`, response.data);
@@ -3112,16 +3125,16 @@ const api = new Api({ apiUrl: 'https://example.com' })`);
     }
     async downloadTaskResults(param) {
         let { taskId, format, filters, sort, view, convertToEnglish = true } = param;
-        /**
-         * Downloads the results of a specific task in the specified format.
-         *
-         * @param taskId The ID of the task.
-         * @param format The format to download the task results in. Available formats are "json", "csv", "excel". The default format is "json".
-         * @param filters A dictionary of filters to apply to the task results, optional.
-         * @param sort The sort to apply to the task results, optional.
-         * @param view The view to apply to the task results, optional.
-         * @param convertToEnglish Whether to convert the task results to English, default is True, optional.
-         * @return A tuple containing the downloaded content as a buffer and the filename.
+        /**
+         * Downloads the results of a specific task in the specified format.
+         *
+         * @param taskId The ID of the task.
+         * @param format The format to download the task results in. Available formats are "json", "csv", "excel". The default format is "json".
+         * @param filters A dictionary of filters to apply to the task results, optional.
+         * @param sort The sort to apply to the task results, optional.
+         * @param view The view to apply to the task results, optional.
+         * @param convertToEnglish Whether to convert the task results to English, default is True, optional.
+         * @return A tuple containing the downloaded content as a buffer and the filename.
          */ const url = this._makeApiUrl(`tasks/${taskId}/download`);
         const payload = {
             convert_to_english: convertToEnglish
@@ -3158,11 +3171,11 @@ const api = new Api({ apiUrl: 'https://example.com' })`);
         }
     }
     async abortTask(taskId) {
-        /**
-         * Aborts a specific task.
-         *
-         * @param taskId The ID of the task to abort.
-         * @return A success message.
+        /**
+         * Aborts a specific task.
+         *
+         * @param taskId The ID of the task to abort.
+         * @return A success message.
          */ const url = this._makeApiUrl(`tasks/${taskId}/abort`);
         try {
             const response = await axios__WEBPACK_IMPORTED_MODULE_1__["default"].patch(url, {}, {
@@ -3180,11 +3193,11 @@ const api = new Api({ apiUrl: 'https://example.com' })`);
         }
     }
     async deleteTask(taskId) {
-        /**
-         * Deletes a specific task.
-         *
-         * @param taskId The ID of the task to delete.
-         * @return A success message.
+        /**
+         * Deletes a specific task.
+         *
+         * @param taskId The ID of the task to delete.
+         * @return A success message.
          */ const url = this._makeApiUrl(`tasks/${taskId}`);
         try {
             const response = await axios__WEBPACK_IMPORTED_MODULE_1__["default"]["delete"](url);
@@ -3199,11 +3212,11 @@ const api = new Api({ apiUrl: 'https://example.com' })`);
     }
     async deleteTasks(param) {
         let { taskIds } = param;
-        /**
-         * Bulk deletes tasks.
-         *
-         * @param taskIds A list of task IDs to be deleted.
-         * @return A success message.
+        /**
+         * Bulk deletes tasks.
+         *
+         * @param taskIds A list of task IDs to be deleted.
+         * @return A success message.
          */ const url = this._makeApiUrl("tasks/bulk-delete");
         const payload = {
             task_ids: taskIds
@@ -3221,11 +3234,11 @@ const api = new Api({ apiUrl: 'https://example.com' })`);
     }
     async abortTasks(param) {
         let { taskIds } = param;
-        /**
-         * Bulk aborts tasks.
-         *
-         * @param taskIds A list of task IDs to be aborted.
-         * @return A success message.
+        /**
+         * Bulk aborts tasks.
+         *
+         * @param taskIds A list of task IDs to be aborted.
+         * @return A success message.
          */ const url = this._makeApiUrl("tasks/bulk-abort");
         const payload = {
             task_ids: taskIds
@@ -3241,22 +3254,25 @@ const api = new Api({ apiUrl: 'https://example.com' })`);
             throw error;
         }
     }
-    constructor({ apiUrl, createResponseFiles = false, apiBasePath = "" } = {
+    constructor({ apiUrl, createResponseFiles = false, apiBasePath = "", enableCache } = {
         createResponseFiles: true
     }){
         (0,_swc_helpers_define_property__WEBPACK_IMPORTED_MODULE_2__._)(this, "_apiUrl", void 0);
         (0,_swc_helpers_define_property__WEBPACK_IMPORTED_MODULE_2__._)(this, "_apiBasePath", void 0);
         (0,_swc_helpers_define_property__WEBPACK_IMPORTED_MODULE_2__._)(this, "_createResponseFiles", void 0);
+        (0,_swc_helpers_define_property__WEBPACK_IMPORTED_MODULE_2__._)(this, "_enableCache", void 0);
         (0,_swc_helpers_define_property__WEBPACK_IMPORTED_MODULE_2__._)(this, "DEFAULT_API_URL", "http://localhost:8000");
-        /**
-         * Initializes the API client with a specified server URL, base path, and an option to create response files.
-         *
-         * @param apiUrl The base URL for the API server. If not specified, defaults to "http://localhost:8000".
-         * @param createResponseFiles Indicates if the client should create response files for each API call. This is useful for debugging or development purposes. Defaults to True.
-         * @param apiBasePath Base path to prefix API endpoints (e.g., "/v1").
+        /**
+         * Initializes the API client with a specified server URL, base path, caching options, and an option to create response files.
+         *
+         * @param apiUrl The base URL for the API server. If not specified, defaults to "http://localhost:8000".
+         * @param createResponseFiles Indicates if the client should create response files for each API call. This is useful for debugging or development purposes. Defaults to true.
+         * @param apiBasePath Base path to prefix API endpoints (e.g., "/v1").
+         * @param enableCache Enable or disable caching for all API requests. Overrides the server's cache setting.
          */ this._apiUrl = apiUrl ? (0,_utils__WEBPACK_IMPORTED_MODULE_0__.removeAfterFirstSlash)(apiUrl) : this.DEFAULT_API_URL;
         this._createResponseFiles = createResponseFiles;
         this._apiBasePath = cleanBasePath(apiBasePath);
+        this._enableCache = enableCache;
         // Check if API is running (note: this is synchronous in the original, but should be async in TS)
         this.isApiRunning().then((isRunning)=>{
             if (!isRunning) {
@@ -7988,7 +8004,7 @@ __webpack_require__.hu = (chunkId) => ('' + chunkId + '.' + __webpack_require__.
 })();
 // webpack/runtime/get_full_hash
 (() => {
-__webpack_require__.h = () => ("e206d326d2bfeb52")
+__webpack_require__.h = () => ("94e1e84fee824fd4")
 })();
 // webpack/runtime/get_main_filename/update manifest
 (() => {