@spider-cloud/spider-client 0.0.54 → 0.0.58

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import { ChunkCallbackFunction, SpiderCoreResponse, SpiderParams } from "./config";
+import { ChunkCallbackFunction, QueryRequest, SpiderCoreResponse, SpiderParams } from "./config";
 /**
  * Generic params for core request.
  */
@@ -148,6 +148,12 @@ export declare class Spider {
      * @returns {Promise<any>} The response from the server.
      */
     getData(table: string, params: GenericParams | Record<string, any>): Promise<any>;
+    /**
+     * Perform a query to get a document.
+     * @param {QueryRequest} params - The query parameters for data retrieval.
+     * @returns {Promise<any>} The response from the server.
+     */
+    query(query: QueryRequest): Promise<any>;
     /**
      * Send a DELETE request to remove data from a specified table.
      * @param {string} table - The table name in the database.

package/dist/client.js

@@ -237,6 +237,14 @@ class Spider {
     async getData(table, params) {
         return this._apiGet(`data/${table}?${new URLSearchParams(params).toString()}`);
     }
+    /**
+     * Perform a query to get a document.
+     * @param {QueryRequest} params - The query parameters for data retrieval.
+     * @returns {Promise<any>} The response from the server.
+     */
+    async query(query) {
+        return this._apiGet(`data/query?${new URLSearchParams(query).toString()}`);
+    }
     /**
      * Send a DELETE request to remove data from a specified table.
      * @param {string} table - The table name in the database.

package/dist/config.d.ts

@@ -78,6 +78,23 @@ interface WaitFor {
     delay?: Delay;
     page_navigations?: boolean;
 }
+/**
+ * Represents the query API endpoint request to get documents from the global spider collection.
+ */
+export interface QueryRequest {
+    /**
+     * The exact URL to get.
+     */
+    url?: string;
+    /**
+     * The domain to get a document from.
+     */
+    domain?: string;
+    /**
+     * The path of the webpage to get the document. This is used with the domain key.
+     */
+    pathname?: string;
+}
 /**
  * Represents the options available for making a spider request.
  */
@@ -230,6 +247,10 @@ export interface SpiderParams {
      * The wait for events on the page. You need to make your `request` `chrome` or `smart`.
      */
     wait_for?: WaitFor;
+    /**
+     * Disable request interception when running 'request' as 'chrome' or 'smart'. This can help when the page uses 3rd party or external scripts to load content.
+     */
+    disable_intercept?: boolean;
 }
 export type SpiderCoreResponse = {
     content?: string;

package/dist/index.d.ts

@@ -1,2 +1,2 @@
 export { Spider } from "./client";
-export type { SpiderParams, Budget, Viewport } from "./config";
+export type { SpiderParams, Budget, Viewport, QueryRequest } from "./config";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spider-cloud/spider-client",
-  "version": "0.0.54",
+  "version": "0.0.58",
   "description": "Isomorphic Javascript SDK for Spider Cloud services",
   "scripts": {
     "test": "node --import tsx  --test __tests__/*test.ts",