@guidelytech/sdk-core 0.10.0 → 0.12.0

package/dist/http-zOI8d2c2.d.cts

@@ -0,0 +1,61 @@
+import { S as ServerHealth } from './health-DjZ2gwYa.cjs';
+
+interface ApiResponse<T> {
+    status: number;
+    ok: boolean;
+    data: T | null;
+    etag: string | null;
+}
+type FetchLike = typeof fetch;
+/** Thin HTTP client for the public SDK API. Adds the public key as query + header. */
+declare class Api {
+    private readonly baseUrl;
+    private readonly key;
+    private readonly fetchImpl?;
+    /** Reachability of the API, fed by every answer (see {@link ServerHealth}). */
+    readonly health: ServerHealth;
+    constructor(baseUrl: string, key: string, fetchImpl?: FetchLike | undefined, health?: ServerHealth);
+    /** Feeds an answer (or a failed request, `null`) into {@link health}. */
+    private observe;
+    url(path: string, params?: Record<string, string | undefined>): string;
+    private get fetcher();
+    request<T>(method: "GET" | "POST", path: string, options?: {
+        body?: unknown;
+        etag?: string | null;
+        params?: Record<string, string | undefined>;
+        keepalive?: boolean;
+        timeoutMs?: number;
+        headers?: Record<string, string>;
+    }): Promise<ApiResponse<T>>;
+    get<T>(path: string, options?: {
+        etag?: string | null;
+        params?: Record<string, string | undefined>;
+        headers?: Record<string, string>;
+    }): Promise<ApiResponse<T>>;
+    post<T>(path: string, body: unknown, options?: {
+        params?: Record<string, string | undefined>;
+        keepalive?: boolean;
+        headers?: Record<string, string>;
+    }): Promise<ApiResponse<T>>;
+    /** Multipart POST (file uploads). No Content-Type header: the browser adds it with the boundary. */
+    postForm<T>(path: string, form: FormData, options?: {
+        params?: Record<string, string | undefined>;
+        timeoutMs?: number;
+    }): Promise<ApiResponse<T>>;
+    /**
+     * POST that may answer with server-sent events. Each event is passed to `onEvent`; a JSON answer is
+     * returned instead. Scout replies can take a while, so there is no overall timeout: the response
+     * must start within 30 s and then never go quiet for more than 60 s (the server sends keepalives),
+     * otherwise the request is aborted and rejects.
+     */
+    stream<T>(path: string, body: unknown, onEvent: (event: string, data: unknown) => void, headers?: Record<string, string>): Promise<ApiResponse<T>>;
+    /** `navigator.sendBeacon` when available (page unload); returns false when it could not be queued. */
+    beacon(path: string, body: unknown): boolean;
+}
+declare const sleep: (ms: number) => Promise<void>;
+/** Exponential backoff helper: 1s → 2s → 4s … capped. */
+declare function backoffMs(attempt: number, baseMs?: number, maxMs?: number): number;
+/** Fire-and-forget POST with bounded retries (used for state sync; never blocks UI). */
+declare function postWithRetry<T>(api: Api, path: string, body: unknown, attempts?: number, baseMs?: number): Promise<ApiResponse<T> | null>;
+
+export { Api as A, type FetchLike as F, type ApiResponse as a, backoffMs as b, postWithRetry as p, sleep as s };