@mangoc/dsh-sub2api-sync 0.0.0-stage → 0.2.0

package/lib/client.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Gateway-side HTTP client for sub2api: model discovery under a relay key.
+ * No DSH dependencies, so it unit-tests against an injected fetch. Phase 2
+ * adds the panel half (login / keys / groups) beside this module.
+ *
+ * @module sub2api-sync/client
+ */
+/**
+ * The `/v1` API root for OpenAI-style gateway endpoints (`/models`,
+ * `/chat/completions`, `/responses`, …). A URL already ending in `/v1`
+ * passes through; anything else gets `/v1` appended.
+ */
+export declare function gatewayApiRoot(baseURL: string): string;
+export interface Sub2apiClientOptions {
+    /** sub2api instance address, with or without a trailing `/v1`. */
+    baseURL: string;
+    /** Fetch implementation override (tests); defaults to globalThis.fetch. */
+    fetchImpl?: typeof fetch;
+}
+/** One model entry as the gateway answers it — the shape varies per platform. */
+export interface GatewayModelEntry {
+    id: string;
+    displayName?: string;
+}
+export declare class Sub2apiClient {
+    private readonly root;
+    private readonly fetchImpl;
+    constructor(options: Sub2apiClientOptions);
+    /**
+     * Discover the model ids one relay key can serve (`GET /v1/models`). The
+     * gateway answers an OpenAI-style list whose element shape varies per
+     * platform — grok embeds reasoning fields, a `client_version` query
+     * switches to the Codex manifest — so the reader takes `id` and tolerates
+     * everything else (verified: `handler/gateway_handler.go`).
+     */
+    listModels(relayKey: string, options?: {
+        signal?: AbortSignal;
+    }): Promise<GatewayModelEntry[]>;
+}
+/**
+ * Extract the gateway's own refusal reason from an error body so the sync
+ * report can say WHY a key was rejected (balance / expiry / subscription /
+ * IP allow-list), not just the HTTP status. sub2api writes two shapes:
+ * flat `{code, message}` (middleware ErrorResponse) and OpenAI-style
+ * `{error: {message, code}}`; anything else degrades to "".
+ */
+export declare function refusalDetail(response: Response): Promise<string>;
+/** Tolerant reader for the `/models` payload; unknown shapes fail loudly. */
+export declare function readModelList(payload: unknown): GatewayModelEntry[];