@hashgrid/sdk 0.2.8 → 0.3.0

package/README.md

@@ -50,9 +50,6 @@ The SDK provides the following resources:
 - **`User`** - User data model
 - **`Quota`** - Quota data model
 - **`Message`** - Message for recv/send operations
-  - Constructor: `new Message(peer_id, round, message = "", score = null)`
-- **`Status`** - Status response from send operations
-  - Properties: `peer_id`, `round`, `success`
 
 ## Examples
 

package/dist/client.d.ts

@@ -6,7 +6,8 @@ export declare class Hashgrid {
     private timeout;
     constructor(api_key?: string, base_url?: string, timeout?: number);
     private _getHeaders;
-    _request(method: string, endpoint: string, params?: Record<string, any>, json_data?: any): Promise<any>;
+    request(method: string, endpoint: string, params?: Record<string, any>, json_data?: any): Promise<any>;
     _handleResponse(response: Response): Promise<any>;
+    stream(method: string, endpoint: string, params?: Record<string, any>, json_data?: any): AsyncGenerator<string>;
     static connect(api_key?: string, base_url?: string, timeout?: number): Promise<Grid>;
 }

package/dist/client.js

@@ -20,7 +20,7 @@ class Hashgrid {
         }
         return headers;
     }
-    async _request(method, endpoint, params, json_data) {
+    async request(method, endpoint, params, json_data) {
         let url;
         if (endpoint.startsWith("http://") || endpoint.startsWith("https://")) {
             url = endpoint;
@@ -104,9 +104,58 @@ class Hashgrid {
             throw new exceptions_1.HashgridAPIError(`Response handling failed: ${error}`);
         }
     }
+    async *stream(method, endpoint, params, json_data) {
+        const base = this.base_url.endsWith("/") ? this.base_url.slice(0, -1) : this.base_url;
+        const path = endpoint.startsWith("/") ? endpoint : `/${endpoint}`;
+        let url = `${base}${path}`;
+        if (params) {
+            const searchParams = new URLSearchParams();
+            Object.entries(params).forEach(([key, value]) => {
+                searchParams.append(key, String(value));
+            });
+            url += `?${searchParams.toString()}`;
+        }
+        const headers = this._getHeaders();
+        headers["Accept"] = "text/event-stream";
+        const options = {
+            method,
+            headers,
+        };
+        if (json_data !== undefined) {
+            options.body = JSON.stringify(json_data);
+        }
+        const response = await fetch(url, options);
+        if (!response.ok) {
+            throw new exceptions_1.HashgridAPIError(`SSE connection failed: ${response.status}`);
+        }
+        const reader = response.body?.getReader();
+        const decoder = new TextDecoder();
+        let buffer = "";
+        if (!reader) {
+            throw new exceptions_1.HashgridAPIError("Response body is not readable");
+        }
+        try {
+            while (true) {
+                const { done, value } = await reader.read();
+                if (done)
+                    break;
+                buffer += decoder.decode(value, { stream: true });
+                const lines = buffer.split("\n\n");
+                buffer = lines.pop() || "";
+                for (const line of lines) {
+                    if (line.startsWith("data: ")) {
+                        yield line.slice(6).trim();
+                    }
+                }
+            }
+        }
+        finally {
+            reader.releaseLock();
+        }
+    }
     static async connect(api_key, base_url = "https://dna.hashgrid.ai", timeout = 30000) {
         const client = new Hashgrid(api_key, base_url, timeout);
-        const data = await client._request("GET", "/api/v1");
+        const data = await client.request("GET", "/api/v1");
         const grid = new resources_1.Grid(data.name, data.tick, client);
         return grid;
     }

package/dist/resources.d.ts

@@ -40,7 +40,7 @@ export declare class Grid {
     tick: number;
     private _client;
     constructor(name: string, tick: number, client: Hashgrid);
-    listen(poll_interval?: number): AsyncGenerator<number>;
+    listen(): AsyncGenerator<number>;
     nodes(): AsyncGenerator<Node>;
     create_node(name: string, message?: string, capacity?: number): Promise<Node>;
 }
@@ -53,7 +53,7 @@ export declare class Node {
     private _client;
     constructor(node_id: string, owner_id: string, name: string, message: string, capacity: number, client: Hashgrid);
     recv(): Promise<Message[]>;
-    send(replies: Message[]): Promise<Status[]>;
+    send(replies: Message[]): Promise<Message[]>;
     update(name?: string, message?: string, capacity?: number): Promise<Node>;
     delete(): Promise<void>;
 }

package/dist/resources.js

@@ -53,35 +53,24 @@ class Grid {
         this.tick = tick;
         this._client = client;
     }
-    async *listen(poll_interval = 30000) {
-        let last_tick = -1;
-        while (true) {
-            try {
-                const data = await this._client._request("GET", "/api/v1");
-                this.name = data.name;
-                this.tick = data.tick;
-                const current_tick = this.tick;
-                if (current_tick !== last_tick) {
-                    yield current_tick;
-                    last_tick = current_tick;
-                }
-                await new Promise((resolve) => setTimeout(resolve, poll_interval));
-            }
-            catch (error) {
-                console.warn(`Error while listening for ticks: ${error}`);
-                await new Promise((resolve) => setTimeout(resolve, poll_interval * 2));
+    async *listen() {
+        for await (const data of this._client.stream("GET", "/api/v1/listen")) {
+            const tick = parseInt(data, 10);
+            if (!isNaN(tick) && tick !== this.tick) {
+                this.tick = tick;
+                yield tick;
             }
         }
     }
     async *nodes() {
-        const data = await this._client._request("GET", "/api/v1/node");
+        const data = await this._client.request("GET", "/api/v1/node");
         for (const item of data) {
             yield new Node(item.node_id, item.owner_id, item.name, item.message, item.capacity, this._client);
         }
     }
     async create_node(name, message = "", capacity = 100) {
         const json_data = { name, message, capacity };
-        const data = await this._client._request("POST", "/api/v1/node", undefined, json_data);
+        const data = await this._client.request("POST", "/api/v1/node", undefined, json_data);
         return new Node(data.node_id, data.owner_id, data.name, data.message, data.capacity, this._client);
     }
 }
@@ -96,7 +85,7 @@ class Node {
         this._client = client;
     }
     async recv() {
-        const data = await this._client._request("GET", `/api/v1/node/${this.node_id}/recv`);
+        const data = await this._client.request("GET", `/api/v1/node/${this.node_id}/recv`);
         return data.map((item) => new Message(item.peer_id, item.round, item.message, item.score ?? null));
     }
     async send(replies) {
@@ -111,8 +100,8 @@ class Node {
             }
             return obj;
         });
-        const data = await this._client._request("POST", `/api/v1/node/${this.node_id}/send`, undefined, json_data);
-        return data.map((item) => new Status(item.peer_id, item.round, item.success));
+        const data = await this._client.request("POST", `/api/v1/node/${this.node_id}/send`, undefined, json_data);
+        return data.map((item) => new Message(item.peer_id, item.round, item.message, item.score ?? null));
     }
     async update(name, message, capacity) {
         const json_data = {};
@@ -125,7 +114,7 @@ class Node {
         if (Object.keys(json_data).length === 0) {
             return this;
         }
-        const data = await this._client._request("PUT", `/api/v1/node/${this.node_id}`, undefined, json_data);
+        const data = await this._client.request("PUT", `/api/v1/node/${this.node_id}`, undefined, json_data);
         // Update local attributes
         if (data.name !== undefined)
             this.name = data.name;
@@ -136,7 +125,7 @@ class Node {
         return this;
     }
     async delete() {
-        await this._client._request("DELETE", `/api/v1/node/${this.node_id}`);
+        await this._client.request("DELETE", `/api/v1/node/${this.node_id}`);
     }
 }
 exports.Node = Node;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hashgrid/sdk",
-  "version": "0.2.8",
+  "version": "0.3.0",
   "description": "Hashgrid TypeScript/JavaScript SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/client.ts

@@ -34,7 +34,7 @@ export class Hashgrid {
     return headers;
   }
 
-  async _request(
+  async request(
     method: string,
     endpoint: string,
     params?: Record<string, any>,
@@ -148,13 +148,81 @@ export class Hashgrid {
     }
   }
 
+  async *stream(
+    method: string,
+    endpoint: string,
+    params?: Record<string, any>,
+    json_data?: any
+  ): AsyncGenerator<string> {
+    const base = this.base_url.endsWith("/") ? this.base_url.slice(0, -1) : this.base_url;
+    const path = endpoint.startsWith("/") ? endpoint : `/${endpoint}`;
+    let url = `${base}${path}`;
+
+    if (params) {
+      const searchParams = new URLSearchParams();
+      Object.entries(params).forEach(([key, value]) => {
+        searchParams.append(key, String(value));
+      });
+      url += `?${searchParams.toString()}`;
+    }
+
+    const headers = this._getHeaders();
+    headers["Accept"] = "text/event-stream";
+
+    const options: {
+      method: string;
+      headers: Record<string, string>;
+      body?: string;
+    } = {
+      method,
+      headers,
+    };
+
+    if (json_data !== undefined) {
+      options.body = JSON.stringify(json_data);
+    }
+
+    const response = await fetch(url, options);
+
+    if (!response.ok) {
+      throw new HashgridAPIError(`SSE connection failed: ${response.status}`);
+    }
+
+    const reader = response.body?.getReader();
+    const decoder = new TextDecoder();
+    let buffer = "";
+
+    if (!reader) {
+      throw new HashgridAPIError("Response body is not readable");
+    }
+
+    try {
+      while (true) {
+        const { done, value } = await reader.read();
+        if (done) break;
+
+        buffer += decoder.decode(value, { stream: true });
+        const lines = buffer.split("\n\n");
+        buffer = lines.pop() || "";
+
+        for (const line of lines) {
+          if (line.startsWith("data: ")) {
+            yield line.slice(6).trim();
+          }
+        }
+      }
+    } finally {
+      reader.releaseLock();
+    }
+  }
+
   static async connect(
     api_key?: string,
     base_url: string = "https://dna.hashgrid.ai",
     timeout: number = 30000
   ): Promise<Grid> {
     const client = new Hashgrid(api_key, base_url, timeout);
-    const data = await client._request("GET", "/api/v1");
+    const data = await client.request("GET", "/api/v1");
     const grid = new Grid(data.name, data.tick, client);
     return grid;
   }

package/src/resources.ts

@@ -100,30 +100,18 @@ export class Grid {
     this._client = client;
   }
 
-  async *listen(poll_interval: number = 30000): AsyncGenerator<number> {
-    let last_tick = -1;
-    while (true) {
-      try {
-        const data = await this._client._request("GET", "/api/v1");
-        this.name = data.name;
-        this.tick = data.tick;
-        const current_tick = this.tick;
-
-        if (current_tick !== last_tick) {
-          yield current_tick;
-          last_tick = current_tick;
-        }
-
-        await new Promise((resolve) => setTimeout(resolve, poll_interval));
-      } catch (error) {
-        console.warn(`Error while listening for ticks: ${error}`);
-        await new Promise((resolve) => setTimeout(resolve, poll_interval * 2));
+  async *listen(): AsyncGenerator<number> {
+    for await (const data of this._client.stream("GET", "/api/v1/listen")) {
+      const tick = parseInt(data, 10);
+      if (!isNaN(tick) && tick !== this.tick) {
+        this.tick = tick;
+        yield tick;
       }
     }
   }
 
   async *nodes(): AsyncGenerator<Node> {
-    const data = await this._client._request("GET", "/api/v1/node");
+    const data = await this._client.request("GET", "/api/v1/node");
     for (const item of data) {
       yield new Node(
         item.node_id,
@@ -142,7 +130,7 @@ export class Grid {
     capacity: number = 100
   ): Promise<Node> {
     const json_data = { name, message, capacity };
-    const data = await this._client._request("POST", "/api/v1/node", undefined, json_data);
+    const data = await this._client.request("POST", "/api/v1/node", undefined, json_data);
     return new Node(
       data.node_id,
       data.owner_id,
@@ -179,7 +167,7 @@ export class Node {
   }
 
   async recv(): Promise<Message[]> {
-    const data = await this._client._request(
+    const data = await this._client.request(
       "GET",
       `/api/v1/node/${this.node_id}/recv`
     );
@@ -189,7 +177,7 @@ export class Node {
     );
   }
 
-  async send(replies: Message[]): Promise<Status[]> {
+  async send(replies: Message[]): Promise<Message[]> {
     const json_data = replies.map((msg) => {
       const obj: any = {
         peer_id: msg.peer_id,
@@ -201,13 +189,16 @@ export class Node {
       }
       return obj;
     });
-    const data = await this._client._request(
+    const data = await this._client.request(
       "POST",
       `/api/v1/node/${this.node_id}/send`,
       undefined,
       json_data
     );
-    return data.map((item: any) => new Status(item.peer_id, item.round, item.success));
+    return data.map(
+      (item: any) =>
+        new Message(item.peer_id, item.round, item.message, item.score ?? null)
+    );
   }
 
   async update(
@@ -224,7 +215,7 @@ export class Node {
       return this;
     }
 
-    const data = await this._client._request(
+    const data = await this._client.request(
       "PUT",
       `/api/v1/node/${this.node_id}`,
       undefined,
@@ -240,7 +231,7 @@ export class Node {
   }
 
   async delete(): Promise<void> {
-    await this._client._request("DELETE", `/api/v1/node/${this.node_id}`);
+    await this._client.request("DELETE", `/api/v1/node/${this.node_id}`);
   }
 }