@spider-cloud/spider-client 0.0.34 → 0.0.36

package/README.md

@@ -93,13 +93,13 @@ spider
 
 #### Download storage data
 
-To download stored data like raw HTML or markdown  use the `downloadFiles` method. Provide the website name and an object containing query parameters:
+To download stored data like raw HTML or markdown  use the `createSignedUrl` method. Provide the website name and an object containing query parameters:
 
 ```javascript
 const websiteName = "spider.cloud";
 const queryParams = { limit: 20, page: 0 };
 spider
-  .downloadFiles(websiteName, queryParams)
+  .createSignedUrl(websiteName, queryParams)
   .then((response) => console.log(response))
   .catch((error) => console.error(error));
 ```
@@ -118,7 +118,7 @@ spider
 - **`getCredits()`**: Retrieve account's remaining credits.
 - **`getData(table, params)`**: Retrieve data records from the DB.
 - **`deleteData(table, params)`**: Delete records from the DB.
-- **`downloadFiles(domain, params)`**: Download the records from the DB.
+- **`createSignedUrl(domain, params)`**: Download the records from the DB.
 
 ## Error Handling
 

package/dist/client.d.ts

@@ -108,16 +108,18 @@ export declare class Spider {
      */
     getCrawlState(url: string, params?: GenericParams): Promise<any>;
     /**
-     * Downloads files from the specified user's storage. This will create signed URLS to use.
+     * Create a signed url to download files from the storage.
      * @param {string} [domain] - The domain for the user's storage. If not provided, downloads all files.
-     * @param {Object} [options] - The download options
+     * @param {Object} [options] - The download options.
+     * @param {boolean} [raw] - Return the raw response.
+  
      * @returns {Promise<Response>} The response containing the file stream.
      */
-    downloadFiles(domain?: string, options?: {
+    createSignedUrl(domain?: string, options?: {
         page?: number;
         limit?: number;
         expiresIn?: number;
-    }): Promise<Response>;
+    }, raw?: boolean): Promise<Response>;
     /**
      * Retrieves the number of credits available on the account.
      * @returns {Promise<any>} The current credit balance.

package/dist/client.js

@@ -161,12 +161,14 @@ class Spider {
         return this._apiPost("data/crawl_state", { url: url, ...params });
     }
     /**
-     * Downloads files from the specified user's storage. This will create signed URLS to use.
+     * Create a signed url to download files from the storage.
      * @param {string} [domain] - The domain for the user's storage. If not provided, downloads all files.
-     * @param {Object} [options] - The download options
+     * @param {Object} [options] - The download options.
+     * @param {boolean} [raw] - Return the raw response.
+  
      * @returns {Promise<Response>} The response containing the file stream.
      */
-    async downloadFiles(domain, options) {
+    async createSignedUrl(domain, options, raw) {
         const { page, limit, expiresIn } = options !== null && options !== void 0 ? options : {};
         const params = new URLSearchParams({
             ...(domain && { domain }),
@@ -180,8 +182,13 @@ class Spider {
             method: "GET",
             headers,
         });
-        if (!response.ok) {
-            this.handleError(response, `Failed to download files`);
+        if (!raw) {
+            if (response.ok) {
+                return response.json();
+            }
+            else {
+                this.handleError(response, `Failed to download files`);
+            }
         }
         return response;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spider-cloud/spider-client",
-  "version": "0.0.34",
+  "version": "0.0.36",
   "description": "A Javascript SDK for Spider Cloud services",
   "scripts": {
     "test": "jest",