@hlix/sdk 0.2.0 → 0.3.0

package/dist/api-client/src/client.d.ts

@@ -0,0 +1,43 @@
+/**
+ * The typed transport for the hlix API.
+ *
+ * TRANSPORT-ONLY, and that is a constraint rather than a stage of completion:
+ *
+ *   - no retries — a caller that retries a non-idempotent POST duplicates work,
+ *     and only the caller knows whether that is safe;
+ *   - no caching — a client that serves a stale project silently disagrees with
+ *     the server, and cache invalidation is the consumer's problem (the web app
+ *     already has TanStack Query for exactly this);
+ *   - no auth policy — no credential storage, no token refresh, no re-auth on
+ *     401. The client sends the headers it is handed and reports what came back.
+ *
+ * Everything in that list is real and useful; it belongs to the SDK, which is
+ * allowed to be opinionated. This layer is what the SDK, the CLI, the docs and
+ * any third-party integrator share, so an opinion added here is one nobody can
+ * opt out of. `transport-only.test.ts` asserts each of those three by
+ * behaviour, not by comment.
+ *
+ * The types come from `generated/schema.ts`, which is generated from
+ * `apps/backend/openapi.json` and checked in. This package has NO dependency on
+ * `apps/backend` — see `no-backend-dependency.test.ts`.
+ */
+import { type Client } from "openapi-fetch";
+import type { paths } from "./generated/schema";
+export interface HlixClientOptions {
+    /** Origin the API is served from, e.g. `https://server.hlix.ai`. */
+    baseUrl: string;
+    /**
+     * Headers sent on every request — authentication and tenancy included.
+     *
+     * A STATIC record, deliberately. Accepting a callback here would be the
+     * first inch of an auth policy: something that refreshes a token has to
+     * decide when a token is stale, and that decision is the SDK's. A caller
+     * whose credentials rotate builds a new client or passes headers per call.
+     */
+    headers?: Record<string, string>;
+    /** Override `globalThis.fetch` — for tests, or a runtime that has its own. */
+    fetch?: (input: Request) => Promise<Response>;
+}
+/** The typed client: one method per HTTP verb, keyed by documented path. */
+export type HlixClient = Client<paths>;
+export declare function createHlixClient(options: HlixClientOptions): HlixClient;