@spider-cloud/spider-client 0.0.35 → 0.0.37

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,25 @@ 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.
+
+## Supabase
+
+You can use superbase to directly connect to instances and write your own logic. You first need to install `@supabase/supabase-js` since this package does not install the dep to keep the bundle small and lazy imports 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
 
@@ -131,4 +149,7 @@ 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

@@ -20,6 +20,14 @@ 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.
@@ -108,14 +116,14 @@ 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 {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;

package/dist/client.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Spider = void 0;
 const package_json_1 = require("../package.json");
+const supabase_1 = require("./supabase");
 /**
  * A class to interact with the Spider API.
  */
@@ -18,6 +19,18 @@ 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.
@@ -161,14 +174,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 {boolean} [raw] - Return the raw response.
   
      * @returns {Promise<Response>} The response containing the file stream.
      */
-    async downloadFiles(domain, options, raw) {
+    async createSignedUrl(domain, options, raw) {
         const { page, limit, expiresIn } = options !== null && options !== void 0 ? options : {};
         const params = new URLSearchParams({
             ...(domain && { domain }),

package/dist/supabase.d.ts

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,76 @@
+"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;
+// lazy loaded createClient
+let _createClient = null;
+class Supabase {
+    // Initialize the Supabase client
+    static async init() {
+        if (!_createClient) {
+            _createClient = (await Promise.resolve().then(() => __importStar(require("@supabase/supabase-js")))).createClient;
+        }
+        if (Supabase.instance) {
+            return;
+        }
+        if (Supabase.initPromise) {
+            return Supabase.initPromise;
+        }
+        Supabase.initPromise = (async () => {
+            const windowExists = typeof window !== "undefined";
+            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();
+                const client = _createClient("https://api-data.spider.cloud", String(data), {
+                    auth: {
+                        persistSession: windowExists,
+                        autoRefreshToken: windowExists,
+                    },
+                });
+                if (client) {
+                    Supabase.instance = client;
+                }
+            }
+            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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spider-cloud/spider-client",
-  "version": "0.0.35",
+  "version": "0.0.37",
   "description": "A Javascript SDK for Spider Cloud services",
   "scripts": {
     "test": "jest",
@@ -28,7 +28,8 @@
     "@types/node": "20.14.2",
     "dotenv": "^16.4.5",
     "ts-jest": "^29.1.2",
-    "typescript": "5.4.5"
+    "typescript": "5.4.5",
+    "@supabase/supabase-js": "^2.44.2"
   },
   "jest": {
     "preset": "ts-jest",