@spider-cloud/spider-client 0.0.53 → 0.0.56

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

@@ -28,6 +28,73 @@ export interface ChunkingAlg {
     type: ChunkingAlgType;
     value: number;
 }
+/**
+ * Represents a timeout configuration.
+ * @typedef {Object} Timeout
+ * @property {number} secs - The number of seconds.
+ * @property {number} nanos - The number of nanoseconds.
+ */
+interface Timeout {
+    secs: number;
+    nanos: number;
+}
+/**
+ * Represents the idle network configuration.
+ * @typedef {Object} IdleNetwork
+ * @property {Timeout} timeout - The timeout configuration.
+ */
+interface IdleNetwork {
+    timeout: Timeout;
+}
+/**
+ * Represents the selector configuration.
+ * @typedef {Object} Selector
+ * @property {Timeout} timeout - The timeout configuration.
+ * @property {string} selector - The CSS selector to wait for.
+ */
+interface Selector {
+    timeout: Timeout;
+    selector: string;
+}
+/**
+ * Represents the delay configuration.
+ * @typedef {Object} Delay
+ * @property {Timeout} timeout - The timeout configuration.
+ */
+interface Delay {
+    timeout: Timeout;
+}
+/**
+ * Represents the wait_for configuration.
+ * @typedef {Object} WaitFor
+ * @property {IdleNetwork} [idle_network] - Configuration to wait for network to be idle.
+ * @property {Selector} [selector] - Configuration to wait for a CSS selector.
+ * @property {Delay} [delay] - Configuration to wait for a delay.
+ * @property {boolean} [page_navigations] - Whether to wait for page navigations.
+ */
+interface WaitFor {
+    idle_network?: IdleNetwork;
+    selector?: Selector;
+    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.
  */
@@ -176,6 +243,10 @@ export interface SpiderParams {
      * The chunking algorithm to use.
      */
     chunking_alg?: ChunkingAlg;
+    /**
+     * The wait for events on the page. You need to make your `request` `chrome` or `smart`.
+     */
+    wait_for?: WaitFor;
 }
 export type SpiderCoreResponse = {
     content?: string;
@@ -185,3 +256,4 @@ export type SpiderCoreResponse = {
     url?: string;
 };
 export type ChunkCallbackFunction = (data: SpiderCoreResponse) => void;
+export {};

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.53",
+  "version": "0.0.56",
   "description": "Isomorphic Javascript SDK for Spider Cloud services",
   "scripts": {
     "test": "node --import tsx  --test __tests__/*test.ts",