mirror of
https://github.com/DeBrosOfficial/network-ts-sdk.git
synced 2025-12-11 01:58:49 +00:00
Add proxy request functionality to NetworkClient and update README with usage examples
- Introduced `proxyAnon` method in `NetworkClient` to facilitate anonymous HTTP requests through the Anyone network. - Added `ProxyRequest` and `ProxyResponse` interfaces to define the structure of proxy requests and responses. - Updated README.md with detailed examples on how to use the new proxy functionality, including GET and POST requests. - Enhanced error handling for proxy requests to ensure graceful failure in case of issues.
This commit is contained in:
parent
6f5be86a02
commit
23a742e5d4
34
README.md
34
README.md
@ -272,6 +272,40 @@ peers.forEach((peer) => {
|
|||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Proxy Requests Through Anyone Network
|
||||||
|
|
||||||
|
Make anonymous HTTP requests through the Anyone network:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Simple GET request
|
||||||
|
const response = await client.network.proxyAnon({
|
||||||
|
url: "https://api.example.com/data",
|
||||||
|
method: "GET",
|
||||||
|
headers: {
|
||||||
|
Accept: "application/json",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
console.log(response.status_code); // 200
|
||||||
|
console.log(response.body); // Response data as string
|
||||||
|
console.log(response.headers); // Response headers
|
||||||
|
|
||||||
|
// POST request with body
|
||||||
|
const postResponse = await client.network.proxyAnon({
|
||||||
|
url: "https://api.example.com/submit",
|
||||||
|
method: "POST",
|
||||||
|
headers: {
|
||||||
|
"Content-Type": "application/json",
|
||||||
|
},
|
||||||
|
body: JSON.stringify({ key: "value" }),
|
||||||
|
});
|
||||||
|
|
||||||
|
// Parse JSON response
|
||||||
|
const data = JSON.parse(postResponse.body);
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note:** The proxy endpoint requires authentication (API key or JWT) and only works when the Anyone relay is running on the gateway server.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
### ClientConfig
|
### ClientConfig
|
||||||
|
|||||||
24
src/index.ts
24
src/index.ts
@ -4,7 +4,11 @@ import { DBClient } from "./db/client";
|
|||||||
import { PubSubClient } from "./pubsub/client";
|
import { PubSubClient } from "./pubsub/client";
|
||||||
import { NetworkClient } from "./network/client";
|
import { NetworkClient } from "./network/client";
|
||||||
import { WSClientConfig } from "./core/ws";
|
import { WSClientConfig } from "./core/ws";
|
||||||
import { StorageAdapter, MemoryStorage, LocalStorageAdapter } from "./auth/types";
|
import {
|
||||||
|
StorageAdapter,
|
||||||
|
MemoryStorage,
|
||||||
|
LocalStorageAdapter,
|
||||||
|
} from "./auth/types";
|
||||||
|
|
||||||
export interface ClientConfig extends Omit<HttpClientConfig, "fetch"> {
|
export interface ClientConfig extends Omit<HttpClientConfig, "fetch"> {
|
||||||
apiKey?: string;
|
apiKey?: string;
|
||||||
@ -38,8 +42,9 @@ export function createClient(config: ClientConfig): Client {
|
|||||||
});
|
});
|
||||||
|
|
||||||
// Derive WebSocket URL from baseURL if not explicitly provided
|
// Derive WebSocket URL from baseURL if not explicitly provided
|
||||||
const wsURL = config.wsConfig?.wsURL ??
|
const wsURL =
|
||||||
config.baseURL.replace(/^http/, 'ws').replace(/\/$/, '');
|
config.wsConfig?.wsURL ??
|
||||||
|
config.baseURL.replace(/^http/, "ws").replace(/\/$/, "");
|
||||||
|
|
||||||
const db = new DBClient(httpClient);
|
const db = new DBClient(httpClient);
|
||||||
const pubsub = new PubSubClient(httpClient, {
|
const pubsub = new PubSubClient(httpClient, {
|
||||||
@ -67,11 +72,7 @@ export { PubSubClient, Subscription } from "./pubsub/client";
|
|||||||
export { NetworkClient } from "./network/client";
|
export { NetworkClient } from "./network/client";
|
||||||
export { SDKError } from "./errors";
|
export { SDKError } from "./errors";
|
||||||
export { MemoryStorage, LocalStorageAdapter } from "./auth/types";
|
export { MemoryStorage, LocalStorageAdapter } from "./auth/types";
|
||||||
export type {
|
export type { StorageAdapter, AuthConfig, WhoAmI } from "./auth/types";
|
||||||
StorageAdapter,
|
|
||||||
AuthConfig,
|
|
||||||
WhoAmI,
|
|
||||||
} from "./auth/types";
|
|
||||||
export type * from "./db/types";
|
export type * from "./db/types";
|
||||||
export type {
|
export type {
|
||||||
Message,
|
Message,
|
||||||
@ -79,4 +80,9 @@ export type {
|
|||||||
ErrorHandler,
|
ErrorHandler,
|
||||||
CloseHandler,
|
CloseHandler,
|
||||||
} from "./pubsub/client";
|
} from "./pubsub/client";
|
||||||
export type { PeerInfo, NetworkStatus } from "./network/client";
|
export type {
|
||||||
|
PeerInfo,
|
||||||
|
NetworkStatus,
|
||||||
|
ProxyRequest,
|
||||||
|
ProxyResponse,
|
||||||
|
} from "./network/client";
|
||||||
|
|||||||
@ -14,6 +14,20 @@ export interface NetworkStatus {
|
|||||||
uptime: number;
|
uptime: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface ProxyRequest {
|
||||||
|
url: string;
|
||||||
|
method: string;
|
||||||
|
headers?: Record<string, string>;
|
||||||
|
body?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ProxyResponse {
|
||||||
|
status_code: number;
|
||||||
|
headers: Record<string, string>;
|
||||||
|
body: string;
|
||||||
|
error?: string;
|
||||||
|
}
|
||||||
|
|
||||||
export class NetworkClient {
|
export class NetworkClient {
|
||||||
private httpClient: HttpClient;
|
private httpClient: HttpClient;
|
||||||
|
|
||||||
@ -37,7 +51,9 @@ export class NetworkClient {
|
|||||||
* Get network status.
|
* Get network status.
|
||||||
*/
|
*/
|
||||||
async status(): Promise<NetworkStatus> {
|
async status(): Promise<NetworkStatus> {
|
||||||
const response = await this.httpClient.get<NetworkStatus>("/v1/network/status");
|
const response = await this.httpClient.get<NetworkStatus>(
|
||||||
|
"/v1/network/status"
|
||||||
|
);
|
||||||
return response;
|
return response;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -64,4 +80,40 @@ export class NetworkClient {
|
|||||||
async disconnect(peerId: string): Promise<void> {
|
async disconnect(peerId: string): Promise<void> {
|
||||||
await this.httpClient.post("/v1/network/disconnect", { peer_id: peerId });
|
await this.httpClient.post("/v1/network/disconnect", { peer_id: peerId });
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Proxy an HTTP request through the Anyone network.
|
||||||
|
* Requires authentication (API key or JWT).
|
||||||
|
*
|
||||||
|
* @param request - The proxy request configuration
|
||||||
|
* @returns The proxied response
|
||||||
|
* @throws {SDKError} If the Anyone proxy is not available or the request fails
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* ```ts
|
||||||
|
* const response = await client.network.proxyAnon({
|
||||||
|
* url: 'https://api.example.com/data',
|
||||||
|
* method: 'GET',
|
||||||
|
* headers: {
|
||||||
|
* 'Accept': 'application/json'
|
||||||
|
* }
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* console.log(response.status_code); // 200
|
||||||
|
* console.log(response.body); // Response data
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
async proxyAnon(request: ProxyRequest): Promise<ProxyResponse> {
|
||||||
|
const response = await this.httpClient.post<ProxyResponse>(
|
||||||
|
"/v1/proxy/anon",
|
||||||
|
request
|
||||||
|
);
|
||||||
|
|
||||||
|
// Check if the response contains an error
|
||||||
|
if (response.error) {
|
||||||
|
throw new Error(`Proxy request failed: ${response.error}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
return response;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -27,4 +27,34 @@ describe("Network", () => {
|
|||||||
const peers = await client.network.peers();
|
const peers = await client.network.peers();
|
||||||
expect(Array.isArray(peers)).toBe(true);
|
expect(Array.isArray(peers)).toBe(true);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("should proxy request through Anyone network", async () => {
|
||||||
|
const client = await createTestClient();
|
||||||
|
|
||||||
|
// Test with a simple GET request
|
||||||
|
const response = await client.network.proxyAnon({
|
||||||
|
url: "https://httpbin.org/get",
|
||||||
|
method: "GET",
|
||||||
|
headers: {
|
||||||
|
"User-Agent": "DeBros-SDK-Test/1.0",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(response).toBeDefined();
|
||||||
|
expect(response.status_code).toBe(200);
|
||||||
|
expect(response.body).toBeDefined();
|
||||||
|
expect(typeof response.body).toBe("string");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should handle proxy errors gracefully", async () => {
|
||||||
|
const client = await createTestClient();
|
||||||
|
|
||||||
|
// Test with invalid URL
|
||||||
|
await expect(
|
||||||
|
client.network.proxyAnon({
|
||||||
|
url: "http://localhost:1/invalid",
|
||||||
|
method: "GET",
|
||||||
|
})
|
||||||
|
).rejects.toThrow();
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user