@spider-cloud/spider-client 0.0.70 → 0.0.72

package/README.md

@@ -148,24 +148,6 @@ spider
 - **`deleteData(table, params)`**: Delete records from the DB.
 - **`createSignedUrl(domain, params)`**: Download the records from the DB.
 
-## Supabase
-
-You can use [Supabase](https://supabase.com/docs/reference/javascript) to directly connect to instances and write your own logic. First, you need to install `@supabase/supabase-js` since this package does not include the dependency by default. This keeps the bundle size small and allows for lazy imports of the client.
-
-```ts
-const spiderClient = new Spider({ apiKey: process.env.SPIDER_API_KEY });
-
-// first init the supabase client to get the anon_key from the server.
-await spiderClient.init_supabase();
-
-const auth = await spiderClient.supabase?.auth.signInWithPassword({
-  email: process.env.SPIDER_EMAIL || "",
-  password: process.env.SPIDER_PASSWORD || "",
-});
-
-// now you can do anything with spiderClient.supabase
-```
-
 ## Error Handling
 
 The SDK provides robust error handling and will throw exceptions when it encounters critical issues. Always use `.catch()` on promises to handle these errors gracefully.

package/dist/client.d.ts

@@ -20,14 +20,6 @@ export declare class Spider {
      * @throws Will throw an error if the API key is not provided.
      */
     constructor(props?: SpiderConfig);
-    /**
-     * Init a supabase client.
-     */
-    init_supabase(): Promise<void>;
-    /**
-     *  The supabase client to manage data.
-     */
-    get supabase(): import("@supabase/supabase-js").SupabaseClient<any, "public", any>;
     /**
      * Internal method to handle POST requests.
      * @param {string} endpoint - The API endpoint to which the POST request should be sent.

package/dist/client.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Spider = void 0;
 const config_1 = require("./config");
 const package_json_1 = require("../package.json");
-const supabase_1 = require("./supabase");
 const stream_reader_1 = require("./utils/stream-reader");
 /**
  * A class to interact with the Spider API.
@@ -21,18 +20,6 @@ class Spider {
             throw new Error("No API key provided");
         }
     }
-    /**
-     * Init a supabase client.
-     */
-    async init_supabase() {
-        return await supabase_1.Supabase.init();
-    }
-    /**
-     *  The supabase client to manage data.
-     */
-    get supabase() {
-        return supabase_1.Supabase.client;
-    }
     /**
      * Internal method to handle POST requests.
      * @param {string} endpoint - The API endpoint to which the POST request should be sent.

package/dist/config.d.ts

@@ -38,6 +38,37 @@ interface Timeout {
     secs: number;
     nanos: number;
 }
+/**
+ * Represents the webhook configuration.
+ * @typedef {Object} WebhookSettings
+ * @property {Object} object - The webhook configuration.
+ */
+interface WebhookSettings {
+    /**
+     * The URL or endpoint where the webhook information will be sent.
+     */
+    destination: string;
+    /**
+     * Flag to indicate an action should be taken when all credits are depleted.
+     */
+    on_credits_depleted: boolean;
+    /**
+     * Flag to indicate an action should be taken when half of the credits are depleted.
+     */
+    on_credits_half_depleted: boolean;
+    /**
+     * Flag to trigger a notification on a website status update event.
+     */
+    on_website_status: boolean;
+    /**
+     * Flag to send information about a new page find, such as links and data size.
+     */
+    on_find: boolean;
+    /**
+     * Flag to handle the metadata of a new page that has been found.
+     */
+    on_find_metadata: boolean;
+}
 /**
  * Represents the idle network configuration.
  * @typedef {Object} IdleNetwork
@@ -126,6 +157,7 @@ export type WebAutomation = {
 } | {
     InfiniteScroll: number;
 };
+export type ReturnFormat = "markdown" | "commonmark" | "raw" | "text" | "html2text" | "bytes" | "xml" | "empty";
 export type WebAutomationMap = Record<string, WebAutomation[]>;
 export type ExecutionScriptsMap = Record<string, string>;
 export declare enum RedirectPolicy {
@@ -149,9 +181,9 @@ export interface SpiderParams {
      */
     limit?: number;
     /**
-     * The format in which the result should be returned.
+     * The format in which the result should be returned. When setting the return format as an array a object is returned mapping by the name.
      */
-    return_format?: "markdown" | "commonmark" | "raw" | "text" | "html2text" | "bytes";
+    return_format?: ReturnFormat | ReturnFormat[];
     /**
      * Specifies whether to only visit the top-level domain.
      */
@@ -224,6 +256,10 @@ export interface SpiderParams {
      * Specifies whether the response data should be stored.
      */
     store_data?: boolean;
+    /**
+     * Use webhooks to send data.
+     */
+    webhooks?: WebhookSettings;
     /**
      * Configuration settings for GPT (general purpose texture mappings).
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spider-cloud/spider-client",
-  "version": "0.0.70",
+  "version": "0.0.72",
   "description": "Isomorphic Javascript SDK for Spider Cloud services",
   "scripts": {
     "test": "node --import tsx  --test __tests__/*test.ts",
@@ -23,10 +23,9 @@
   "author": "Jeff Mendez<jeff@a11ywatch.com>",
   "license": "MIT",
   "devDependencies": {
-    "@supabase/supabase-js": "^2.45.0",
-    "@types/node": "20.14.2",
+    "@types/node": "22.7.5",
     "dotenv": "^16.4.5",
-    "tsx": "^4.16.5",
-    "typescript": "5.4.5"
+    "tsx": "^4.19.1",
+    "typescript": "5.6.3"
   }
 }

package/dist/supabase.d.ts

@@ -1,7 +0,0 @@
-import type { SupabaseClient } from "@supabase/supabase-js";
-export declare class Supabase {
-    private static instance?;
-    private static initPromise?;
-    static init(): Promise<void>;
-    static get client(): SupabaseClient;
-}

package/dist/supabase.js

@@ -1,69 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Supabase = void 0;
-class Supabase {
-    // Initialize the Supabase client
-    static async init() {
-        if (Supabase.instance) {
-            return;
-        }
-        if (Supabase.initPromise) {
-            return Supabase.initPromise;
-        }
-        Supabase.initPromise = (async () => {
-            const windowExists = typeof window !== "undefined";
-            const { createClient } = await Promise.resolve().then(() => __importStar(require("@supabase/supabase-js")));
-            try {
-                const response = await fetch("https://api.spider.cloud/data/anon_key");
-                if (!response.ok) {
-                    throw new Error(`Failed to fetch anon key: ${response.statusText}`);
-                }
-                const { data } = await response.json();
-                Supabase.instance = createClient("https://api-data.spider.cloud", String(data), {
-                    auth: {
-                        persistSession: windowExists,
-                        autoRefreshToken: windowExists,
-                    },
-                });
-            }
-            catch (error) {
-                Promise.reject("Failed to initialize Supabase client: " + error);
-            }
-            finally {
-                Supabase.initPromise = undefined; // Clear the init promise
-            }
-        })();
-        return Supabase.initPromise;
-    }
-    // Get the Supabase client instance
-    static get client() {
-        if (!Supabase.instance) {
-            throw new Error("Supabase client is not initialized. Call Supabase.init() first.");
-        }
-        return Supabase.instance;
-    }
-}
-exports.Supabase = Supabase;