@automate.ax/client 0.2.0 → 0.3.1

package/README.md

@@ -11,9 +11,9 @@ bun add @automate.ax/client
 ## API key
 
 ```ts
-import { createClient } from "@automate.ax/client"
+import { createAutomateClient } from "@automate.ax/client"
 
-const client = createClient({
+const client = createAutomateClient({
   apiKey: process.env.AUTOMATE_AX_API_KEY!,
 })
 
@@ -23,5 +23,4 @@ const projects = await client.project.list()
 The key is organization-owned and is sent in the `x-api-key` header. It does
 not represent a user session.
 
-The client targets `https://automate.ax/api/rpc` by default. Use `url`, `headers`,
-or `fetch` to customize its transport.
+The client targets `https://automate.ax/api/rpc`.

package/dist/index.d.ts

@@ -1,20 +1,9 @@
 import type { contract } from "@automate.ax/api-contract";
 import type { ContractRouterClient } from "@orpc/contract";
-export type Client = ContractRouterClient<typeof contract>;
-export type Credential = string | (() => Promise<string | null | undefined> | string | null | undefined);
-export type Fetch = (request: Request, init?: RequestInit) => Promise<Response>;
-type HeadersInit = ConstructorParameters<typeof Headers>[0];
-interface ClientBaseOptions {
-    /** Overrides the default `https://automate.ax/api/rpc` endpoint. */
-    url?: URL | string;
-    /** Adds request headers before the authentication header is applied. */
-    headers?: HeadersInit | (() => HeadersInit | Promise<HeadersInit>);
-    /** Overrides the global Fetch implementation used for requests. */
-    fetch?: Fetch;
-}
-export interface ClientOptions extends ClientBaseOptions {
+export type AutomateClient = ContractRouterClient<typeof contract>;
+export interface AutomateClientOptions {
     /** Automate.ax API key sent through the `x-api-key` header. */
-    apiKey: Credential;
+    apiKey: string | (() => Promise<string | null | undefined> | string | null | undefined);
 }
 /**
  * Creates a type-safe client for every procedure in the public API contract.
@@ -22,7 +11,6 @@ export interface ClientOptions extends ClientBaseOptions {
  * Credential callbacks are evaluated for every request, allowing callers to
  * rotate API keys without recreating the client.
  *
- * @param options - Authentication and transport configuration.
+ * @param options - API authentication options.
  */
-export declare function createClient(options: ClientOptions): Client;
-export {};
+export declare function createAutomateClient(options: AutomateClientOptions): AutomateClient;

package/dist/index.js

@@ -1,33 +1,25 @@
 import { createORPCClient } from "@orpc/client";
 import { RPCLink } from "@orpc/client/fetch";
-const DEFAULT_RPC_URL = "https://automate.ax/api/rpc";
+const RPC_URL = "https://automate.ax/api/rpc";
 /**
  * Creates a type-safe client for every procedure in the public API contract.
  *
  * Credential callbacks are evaluated for every request, allowing callers to
  * rotate API keys without recreating the client.
  *
- * @param options - Authentication and transport configuration.
+ * @param options - API authentication options.
  */
-export function createClient(options) {
-    const customFetch = options.fetch;
+export function createAutomateClient(options) {
     return createORPCClient(new RPCLink({
-        url: options.url ?? DEFAULT_RPC_URL,
+        url: RPC_URL,
         headers: async () => {
-            const headers = new Headers(typeof options.headers === "function"
-                ? await options.headers()
-                : options.headers);
-            const credential = typeof options.apiKey === "function"
+            const headers = new Headers();
+            const apiKey = typeof options.apiKey === "function"
                 ? await options.apiKey()
                 : options.apiKey;
-            if (!credential) {
-                throw new Error("API credentials are unavailable.");
-            }
-            headers.set("x-api-key", credential);
+            if (apiKey)
+                headers.set("x-api-key", apiKey);
             return headers;
         },
-        ...(customFetch && {
-            fetch: (request, init) => customFetch(request, init),
-        }),
     }));
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automate.ax/client",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "Type-safe client for the Automate.ax API.",
   "license": "MIT",
   "repository": {
@@ -37,7 +37,7 @@
     "lint": "oxlint --type-aware",
     "lint:fix": "oxlint --type-aware --fix-suggestions",
     "check": "bun run typecheck && bun run lint",
-    "test": "bun test",
+    "test": "bun test --pass-with-no-tests",
     "build": "zshy -p tsconfig.build.json",
     "prepublishOnly": "bun run check && bun run test && bun run build"
   },