@automate.ax/client 0.76.0 → 0.77.0

package/README.md

@@ -17,9 +17,50 @@ const client = createAutomateClient({
   apiKey: process.env.AUTOMATE_AX_API_KEY!,
 })
 
-const projects = await client.project.list()
+const firstPage = await client.project.list({ limit: 25 })
+
+for (const project of firstPage.items) {
+  console.log(project.name)
+}
+
+if (firstPage.items[0]) {
+  const automations = await client.automation.list({
+    projectId: firstPage.items[0].id,
+    limit: 25,
+  })
+
+  if (automations.items[0]) {
+    const automation = await client.automation.get({
+      automationId: automations.items[0].id,
+    })
+    console.log(automation.triggers)
+  }
+}
 ```
 
+List procedures return `{ items, pageInfo }`. When `pageInfo.hasMore` is true, pass `pageInfo.nextCursor` as the next request's `cursor`.
+
 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`.
+
+## User session
+
+User-scoped procedures, including execution-data discovery, use a signed-in user's bearer session:
+
+```ts
+import { createAutomateClient } from "@automate.ax/client"
+
+const client = createAutomateClient({
+  sessionToken: process.env.AUTOMATE_SESSION_TOKEN!,
+})
+
+const manifest = await client.executionData.manifest({
+  projectId: "proj_01...",
+  since: "2026-08-01T00:00:00Z",
+})
+
+console.log(manifest.consistency, manifest.resources)
+```
+
+Credential callbacks are evaluated before every request, so a client can use a refreshed token without being recreated. Supply either `apiKey` or `sessionToken`.

package/dist/index.d.ts

@@ -1,16 +1,23 @@
 import type { publicContract } from "@automate.ax/api-contract";
 import type { ContractRouterClient } from "@orpc/contract";
 export type AutomateClient = ContractRouterClient<typeof publicContract>;
-export interface AutomateClientOptions {
-    /** Automate.ax API key sent through the `x-api-key` header. */
-    apiKey: string | (() => Promise<string | null | undefined> | string | null | undefined);
-}
+type ClientCredential = string | (() => Promise<string | null | undefined> | string | null | undefined);
+export type AutomateClientOptions = {
+    /** Automate.ax organization API key sent through `x-api-key`. */
+    apiKey: ClientCredential;
+    sessionToken?: never;
+} | {
+    apiKey?: never;
+    /** Automate.ax user-session bearer token. */
+    sessionToken: ClientCredential;
+};
 /**
  * Creates a type-safe client for the public management API.
  *
  * Credential callbacks are evaluated for every request, allowing callers to
- * rotate API keys without recreating the client.
+ * rotate API keys or user-session tokens without recreating the client.
  *
  * @param options - API authentication options.
  */
 export declare function createAutomateClient(options: AutomateClientOptions): AutomateClient;
+export {};

package/dist/index.js

@@ -5,7 +5,7 @@ const RPC_URL = "https://automate.ax/api/rpc";
  * Creates a type-safe client for the public management API.
  *
  * Credential callbacks are evaluated for every request, allowing callers to
- * rotate API keys without recreating the client.
+ * rotate API keys or user-session tokens without recreating the client.
  *
  * @param options - API authentication options.
  */
@@ -14,11 +14,11 @@ export function createAutomateClient(options) {
         url: RPC_URL,
         headers: async () => {
             const headers = new Headers();
-            const apiKey = typeof options.apiKey === "function"
-                ? await options.apiKey()
-                : options.apiKey;
-            if (apiKey)
-                headers.set("x-api-key", apiKey);
+            const credential = options.apiKey ?? options.sessionToken;
+            const value = typeof credential === "function" ? await credential() : credential;
+            if (value) {
+                headers.set(options.apiKey === undefined ? "authorization" : "x-api-key", options.apiKey === undefined ? `Bearer ${value}` : value);
+            }
             return headers;
         },
     }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automate.ax/client",
-  "version": "0.76.0",
+  "version": "0.77.0",
   "description": "Type-safe client for the Automate.ax API.",
   "license": "MIT",
   "repository": {
@@ -26,7 +26,7 @@
     }
   },
   "dependencies": {
-    "@automate.ax/api-contract": "0.76.0",
+    "@automate.ax/api-contract": "0.77.0",
     "@orpc/client": "1.15.0",
     "@orpc/contract": "1.15.0"
   },

package/src/index.ts

@@ -8,18 +8,28 @@ const RPC_URL = "https://automate.ax/api/rpc"
 // this is an exception to the "no branding in code" rule
 export type AutomateClient = ContractRouterClient<typeof publicContract>
 
-export interface AutomateClientOptions {
-  /** Automate.ax API key sent through the `x-api-key` header. */
-  apiKey:
-    | string
-    | (() => Promise<string | null | undefined> | string | null | undefined)
-}
+type ClientCredential =
+  | string
+  | (() => Promise<string | null | undefined> | string | null | undefined)
+
+export type AutomateClientOptions =
+  | {
+      /** Automate.ax organization API key sent through `x-api-key`. */
+      apiKey: ClientCredential
+      sessionToken?: never
+    }
+  | {
+      apiKey?: never
+
+      /** Automate.ax user-session bearer token. */
+      sessionToken: ClientCredential
+    }
 
 /**
  * Creates a type-safe client for the public management API.
  *
  * Credential callbacks are evaluated for every request, allowing callers to
- * rotate API keys without recreating the client.
+ * rotate API keys or user-session tokens without recreating the client.
  *
  * @param options - API authentication options.
  */
@@ -31,12 +41,16 @@ export function createAutomateClient(
       url: RPC_URL,
       headers: async () => {
         const headers = new Headers()
-        const apiKey =
-          typeof options.apiKey === "function"
-            ? await options.apiKey()
-            : options.apiKey
+        const credential = options.apiKey ?? options.sessionToken
+        const value =
+          typeof credential === "function" ? await credential() : credential
 
-        if (apiKey) headers.set("x-api-key", apiKey)
+        if (value) {
+          headers.set(
+            options.apiKey === undefined ? "authorization" : "x-api-key",
+            options.apiKey === undefined ? `Bearer ${value}` : value,
+          )
+        }
 
         return headers
       },