@spider-cloud/spider-client 0.0.19 → 0.0.21

package/README.md

@@ -25,7 +25,7 @@ Before using the SDK, you will need to provide it with your API key. Obtain an A
 Here's a basic example to demonstrate how to use the SDK:
 
 ```javascript
-import { Spider } from '@spider-cloud/spider-client';
+import { Spider } from "@spider-cloud/spider-client";
 
 // Initialize the SDK with your API key
 const app = new Spider({ apiKey: "YOUR_API_KEY" });
@@ -59,6 +59,38 @@ app
   });
 ```
 
+### Data Operations
+
+The Spider client can interact with specific data tables to create, retrieve, and delete data.
+
+#### Retrieve Data from a Table
+
+To fetch data from a specified table by applying query parameters, use the `getData` method. Provide the table name and an object containing query parameters:
+
+```javascript
+const tableName = "pages";
+const queryParams = { limit: 20 };
+spider
+  .getData(tableName, queryParams)
+  .then((response) => console.log(response))
+  .catch((error) => console.error(error));
+```
+
+This example retrieves data from the 'pages' table, limiting the results to 20 entries.
+
+#### Delete Data from a Table
+
+To delete data from a specified table based on certain conditions, use the `deleteData` method. Provide the table name and an object specifying the conditions for deletion:
+
+```javascript
+const tableName = "websites";
+const deleteParams = { domain: "www.example.com" };
+spider
+  .deleteData(tableName, deleteParams)
+  .then((response) => console.log(response))
+  .catch((error) => console.error(error));
+```
+
 ### Available Methods
 
 - **`scrapeUrl(url, params)`**: Scrape data from a specified URL. Optional parameters can be passed to customize the scraping behavior.
@@ -69,6 +101,8 @@ app
 - **`label(url, params)`**: Apply labeling to data extracted from the specified URL.
 - **`getCrawlState(url, params)`**: Check the website crawl state.
 - **`getCredits()`**: Retrieve account's remaining credits.
+- **`getData(table, params)`**: Retrieve data records from the DB.
+- **`deleteData(table, params)`**: Delete records from the DB.
 
 ## Error Handling
 
@@ -81,3 +115,4 @@ Contributions are always welcome! Feel free to open an issue or submit a pull re
 ## License
 
 The Spider Cloud JavaScript SDK is open-source and released under the [MIT License](https://opensource.org/licenses/MIT).
+```

package/dist/client.d.ts

@@ -29,6 +29,12 @@ export declare class Spider {
      * @returns {Promise<any>} The data returned from the endpoint in JSON format.
      */
     private _apiGet;
+    /**
+     * Internal method to handle DELETE requests.
+     * @param {string} endpoint - The API endpoint from which data should be retrieved.
+     * @returns {Promise<any>} The data returned from the endpoint in JSON format.
+     */
+    private _apiDelete;
     /**
      * Scrapes data from a specified URL.
      * @param {string} url - The URL to scrape.
@@ -84,6 +90,27 @@ export declare class Spider {
      * @returns {Promise<any>} The current credit balance.
      */
     getCredits(): Promise<any>;
+    /**
+     * Send a POST request to insert data into a specified table.
+     * @param {string} table - The table name in the database.
+     * @param {object} data - The data to be inserted.
+     * @returns {Promise<any>} The response from the server.
+     */
+    postData(table: string, data: object): Promise<any>;
+    /**
+     * Send a GET request to retrieve data from a specified table.
+     * @param {string} table - The table name in the database.
+     * @param {object} params - The query parameters for data retrieval.
+     * @returns {Promise<any>} The response from the server.
+     */
+    getData(table: string, params: object): Promise<any>;
+    /**
+     * Send a DELETE request to remove data from a specified table.
+     * @param {string} table - The table name in the database.
+     * @param {object} params - Parameters to identify records to delete.
+     * @returns {Promise<any>} The response from the server.
+     */
+    deleteData(table: string, params: object): Promise<any>;
     /**
      * Prepares common headers for each API request.
      * @returns {HeadersInit} A headers object for fetch requests.

package/dist/client.js

@@ -59,6 +59,24 @@ class Spider {
             this.handleError(response, `get from ${endpoint}`);
         }
     }
+    /**
+     * Internal method to handle DELETE requests.
+     * @param {string} endpoint - The API endpoint from which data should be retrieved.
+     * @returns {Promise<any>} The data returned from the endpoint in JSON format.
+     */
+    async _apiDelete(endpoint) {
+        const headers = this.prepareHeaders();
+        const response = await fetch(`https://api.spider.cloud/v1/${endpoint}`, {
+            method: "DELETE",
+            headers,
+        });
+        if (response.ok) {
+            return response.json();
+        }
+        else {
+            this.handleError(response, `get from ${endpoint}`);
+        }
+    }
     /**
      * Scrapes data from a specified URL.
      * @param {string} url - The URL to scrape.
@@ -130,6 +148,33 @@ class Spider {
     async getCredits() {
         return this._apiGet("credits");
     }
+    /**
+     * Send a POST request to insert data into a specified table.
+     * @param {string} table - The table name in the database.
+     * @param {object} data - The data to be inserted.
+     * @returns {Promise<any>} The response from the server.
+     */
+    async postData(table, data) {
+        return this._apiPost(`data/${table}`, data);
+    }
+    /**
+     * Send a GET request to retrieve data from a specified table.
+     * @param {string} table - The table name in the database.
+     * @param {object} params - The query parameters for data retrieval.
+     * @returns {Promise<any>} The response from the server.
+     */
+    async getData(table, params) {
+        return this._apiGet(`data/${table}?${new URLSearchParams(params).toString()}`);
+    }
+    /**
+     * Send a DELETE request to remove data from a specified table.
+     * @param {string} table - The table name in the database.
+     * @param {object} params - Parameters to identify records to delete.
+     * @returns {Promise<any>} The response from the server.
+     */
+    async deleteData(table, params) {
+        return this._apiDelete(`data/${table}?${new URLSearchParams(params).toString()}`);
+    }
     /**
      * Prepares common headers for each API request.
      * @returns {HeadersInit} A headers object for fetch requests.

package/package.json

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