@simular-ai/sai-sdk 0.0.0-stage → 0.1.0-alpha.1

package/dist/tenants.d.ts

@@ -0,0 +1,66 @@
+import type { Sai } from './client.js';
+import type { Credential, Http } from './http.js';
+import { type Enrollment, type Tenant, type TenantMachine, type TenantPage, type TenantToken } from './types.js';
+export type TenantRef = Tenant | string;
+export type TenantMachineRef = TenantMachine | string;
+/** `tenants.client()` exchanges again when its token has less than this left. */
+export declare const TOKEN_REFRESH_MARGIN_MS: number;
+/** Tenants: your customers, under an Organisation. Every call takes an Organisation Key. */
+export declare class Tenants {
+    private readonly http;
+    private readonly orgId;
+    private readonly withCredential;
+    constructor(http: Http, orgId: string | undefined, withCredential: (credential: Credential) => Sai);
+    /** `externalId` is your id for the customer, unique in the Organisation, and cannot change later. */
+    create(name: string, opts?: {
+        externalId?: string;
+        metadata?: Record<string, string>;
+    }): Promise<Tenant>;
+    /**
+     * One page, newest first. `externalId` finds the Tenant with that id (zero or one) and
+     * cannot be combined with `status`.
+     */
+    list(opts?: {
+        status?: string;
+        externalId?: string;
+        limit?: number;
+        cursor?: string;
+    }): Promise<TenantPage>;
+    get(tenant: TenantRef): Promise<Tenant>;
+    /**
+     * `metadata` replaces the whole map. `status: 'disabled'` stops the Tenant's tokens and
+     * machines; `status: 'active'` brings it back.
+     */
+    update(tenant: TenantRef, opts: {
+        name?: string;
+        metadata?: Record<string, string>;
+        status?: string;
+    }): Promise<Tenant>;
+    /** Disables the Tenant and revokes every machine. Its data is kept: erase it from the console. */
+    delete(tenant: TenantRef): Promise<void>;
+    /** A single-use code that enrolls one computer into the Tenant. It expires in 15 minutes. */
+    createEnrollment(tenant: TenantRef): Promise<Enrollment>;
+    /**
+     * Exchange the Organisation Key for a one-hour token that acts as the Tenant. `orgId`
+     * defaults to the client's `orgId` (`SAI_ORG_ID`).
+     */
+    token(tenant: TenantRef, opts?: {
+        orgId?: string;
+    }): Promise<TenantToken>;
+    /**
+     * A client that acts as the Tenant. It exchanges a token now, and again before a request
+     * when the token has less than five minutes left. Uses this client's Organisation Key.
+     */
+    client(tenant: TenantRef, opts?: {
+        orgId?: string;
+    }): Promise<Sai>;
+}
+/** A Tenant's enrolled computers. Every call takes an Organisation Key. */
+export declare class TenantMachines {
+    private readonly http;
+    constructor(http: Http);
+    list(tenant: TenantRef): Promise<TenantMachine[]>;
+    get(tenant: TenantRef, machineId: string): Promise<TenantMachine>;
+    /** Signs the machine out at once. To bring it back, enroll it again with a new code. */
+    revoke(tenant: TenantRef, machine: TenantMachineRef): Promise<void>;
+}

package/dist/tenants.js

@@ -0,0 +1,97 @@
+import { parseEnrollment, parseTenant, parseTenantMachine, parseTenantToken, } from './types.js';
+/** `tenants.client()` exchanges again when its token has less than this left. */
+export const TOKEN_REFRESH_MARGIN_MS = 5 * 60 * 1000;
+const q = encodeURIComponent;
+const tenantPath = (tenant) => `/v1/tenants/${q(typeof tenant === 'string' ? tenant : tenant.id)}`;
+/** Tenants: your customers, under an Organisation. Every call takes an Organisation Key. */
+export class Tenants {
+    http;
+    orgId;
+    withCredential;
+    constructor(http, orgId, withCredential) {
+        this.http = http;
+        this.orgId = orgId;
+        this.withCredential = withCredential;
+    }
+    /** `externalId` is your id for the customer, unique in the Organisation, and cannot change later. */
+    async create(name, opts = {}) {
+        return parseTenant(await this.http.json('POST', '/v1/tenants', {
+            json: { name, externalId: opts.externalId, metadata: opts.metadata },
+        }));
+    }
+    /**
+     * One page, newest first. `externalId` finds the Tenant with that id (zero or one) and
+     * cannot be combined with `status`.
+     */
+    async list(opts = {}) {
+        const d = await this.http.json('GET', '/v1/tenants', { params: opts });
+        return { tenants: (d.tenants ?? []).map(parseTenant), nextCursor: d.nextCursor ?? null };
+    }
+    async get(tenant) {
+        return parseTenant(await this.http.json('GET', tenantPath(tenant)));
+    }
+    /**
+     * `metadata` replaces the whole map. `status: 'disabled'` stops the Tenant's tokens and
+     * machines; `status: 'active'` brings it back.
+     */
+    async update(tenant, opts) {
+        return parseTenant(await this.http.json('PATCH', tenantPath(tenant), { json: opts }));
+    }
+    /** Disables the Tenant and revokes every machine. Its data is kept: erase it from the console. */
+    async delete(tenant) {
+        await this.http.request('DELETE', tenantPath(tenant));
+    }
+    /** A single-use code that enrolls one computer into the Tenant. It expires in 15 minutes. */
+    async createEnrollment(tenant) {
+        return parseEnrollment(await this.http.json('POST', `${tenantPath(tenant)}/enrollments`));
+    }
+    /**
+     * Exchange the Organisation Key for a one-hour token that acts as the Tenant. `orgId`
+     * defaults to the client's `orgId` (`SAI_ORG_ID`).
+     */
+    async token(tenant, opts = {}) {
+        const orgId = opts.orgId ?? this.orgId;
+        if (!orgId) {
+            throw new Error('No Organisation id: pass orgId here or to new Sai(), or set SAI_ORG_ID.');
+        }
+        const id = typeof tenant === 'string' ? tenant : tenant.id;
+        return parseTenantToken(await this.http.json('POST', `/v1/orgs/${q(orgId)}/tenants/${q(id)}/token`));
+    }
+    /**
+     * A client that acts as the Tenant. It exchanges a token now, and again before a request
+     * when the token has less than five minutes left. Uses this client's Organisation Key.
+     */
+    async client(tenant, opts = {}) {
+        let current = await this.token(tenant, opts);
+        let pending;
+        return this.withCredential(async () => {
+            if (current.expiresAt - Date.now() >= TOKEN_REFRESH_MARGIN_MS)
+                return current.token;
+            pending ??= this.token(tenant, opts).finally(() => {
+                pending = undefined;
+            });
+            current = await pending;
+            return current.token;
+        });
+    }
+}
+/** A Tenant's enrolled computers. Every call takes an Organisation Key. */
+export class TenantMachines {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    async list(tenant) {
+        const d = await this.http.json('GET', `${tenantPath(tenant)}/machines`);
+        return (d.machines ?? []).map(parseTenantMachine);
+    }
+    async get(tenant, machineId) {
+        return parseTenantMachine(await this.http.json('GET', `${tenantPath(tenant)}/machines/${q(machineId)}`));
+    }
+    /** Signs the machine out at once. To bring it back, enroll it again with a new code. */
+    async revoke(tenant, machine) {
+        const id = typeof machine === 'string' ? machine : machine.id;
+        await this.http.request('DELETE', `${tenantPath(tenant)}/machines/${q(id)}`);
+    }
+}
+//# sourceMappingURL=tenants.js.map

package/dist/tenants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tenants.js","sourceRoot":"","sources":["../src/tenants.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,eAAe,EACf,WAAW,EACX,kBAAkB,EAClB,gBAAgB,GAMjB,MAAM,YAAY,CAAA;AAKnB,iFAAiF;AACjF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAA;AAEpD,MAAM,CAAC,GAAG,kBAAkB,CAAA;AAC5B,MAAM,UAAU,GAAG,CAAC,MAAiB,EAAU,EAAE,CAC/C,eAAe,CAAC,CAAC,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAA;AAErE,4FAA4F;AAC5F,MAAM,OAAO,OAAO;IAEC;IACA;IACA;IAHnB,YACmB,IAAU,EACV,KAAyB,EACzB,cAA+C;QAF/C,SAAI,GAAJ,IAAI,CAAM;QACV,UAAK,GAAL,KAAK,CAAoB;QACzB,mBAAc,GAAd,cAAc,CAAiC;IAC/D,CAAC;IAEJ,qGAAqG;IACrG,KAAK,CAAC,MAAM,CACV,IAAY,EACZ,OAAmE,EAAE;QAErE,OAAO,WAAW,CAChB,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,EAAE;YAC1C,IAAI,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE;SACrE,CAAC,CACH,CAAA;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI,CACR,OAAkF,EAAE;QAEpF,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAC5B,KAAK,EACL,aAAa,EACb,EAAE,MAAM,EAAE,IAAI,EAAE,CACjB,CAAA;QACD,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,UAAU,IAAI,IAAI,EAAE,CAAA;IAC1F,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,MAAiB;QACzB,OAAO,WAAW,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IACrE,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CACV,MAAiB,EACjB,IAA2E;QAE3E,OAAO,WAAW,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;IACvF,CAAC;IAED,kGAAkG;IAClG,KAAK,CAAC,MAAM,CAAC,MAAiB;QAC5B,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,CAAA;IACvD,CAAC;IAED,6FAA6F;IAC7F,KAAK,CAAC,gBAAgB,CAAC,MAAiB;QACtC,OAAO,eAAe,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAA;IAC3F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAAK,CAAC,MAAiB,EAAE,OAA2B,EAAE;QAC1D,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAA;QACtC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,yEAAyE,CAAC,CAAA;QAC5F,CAAC;QACD,MAAM,EAAE,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAA;QAC1D,OAAO,gBAAgB,CACrB,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAC5E,CAAA;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAC,MAAiB,EAAE,OAA2B,EAAE;QAC3D,IAAI,OAAO,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAC5C,IAAI,OAAyC,CAAA;QAC7C,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,IAAI,EAAE;YACpC,IAAI,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,IAAI,uBAAuB;gBAAE,OAAO,OAAO,CAAC,KAAK,CAAA;YACnF,OAAO,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE;gBAChD,OAAO,GAAG,SAAS,CAAA;YACrB,CAAC,CAAC,CAAA;YACF,OAAO,GAAG,MAAM,OAAO,CAAA;YACvB,OAAO,OAAO,CAAC,KAAK,CAAA;QACtB,CAAC,CAAC,CAAA;IACJ,CAAC;CACF;AAED,2EAA2E;AAC3E,MAAM,OAAO,cAAc;IACI;IAA7B,YAA6B,IAAU;QAAV,SAAI,GAAJ,IAAI,CAAM;IAAG,CAAC;IAE3C,KAAK,CAAC,IAAI,CAAC,MAAiB;QAC1B,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAC5B,KAAK,EACL,GAAG,UAAU,CAAC,MAAM,CAAC,WAAW,CACjC,CAAA;QACD,OAAO,CAAC,CAAC,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAA;IACnD,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,MAAiB,EAAE,SAAiB;QAC5C,OAAO,kBAAkB,CACvB,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAC9E,CAAA;IACH,CAAC;IAED,wFAAwF;IACxF,KAAK,CAAC,MAAM,CAAC,MAAiB,EAAE,OAAyB;QACvD,MAAM,EAAE,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAA;QAC7D,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAA;IAC9E,CAAC;CACF"}

package/dist/turns.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Turns: what a message to Sai started or joined. Every message gets a turn id
+ * (`turn.id`); this reads the turn's record: status, output, evidence, usage,
+ * and its trajectory when the message set `recordTrajectory`.
+ *
+ * Maps to `/v1/agents/turns/*`.
+ */
+import type { Http } from './http.js';
+import { type TrajectoryStep, type TurnRecord } from './types.js';
+/** A turn id, a `Turn`, or a `TurnRecord`. */
+export type TurnRef = string | {
+    id: string | null;
+};
+export declare class Turns {
+    private readonly http;
+    constructor(http: Http);
+    /** The turn's record now. Never waits: `finalizing` while the result is worked out. */
+    get(turn: TurnRef): Promise<TurnRecord>;
+    /**
+     * Read the turn until it is `succeeded`, `failed` or `needs_input`. On
+     * `needs_input`, answer the approval on the turn's session
+     * (`sai.sessions.resume(record.sessionId)`) and wait again. `timeoutMs`
+     * throws a `TimeoutError` (DOMException) with the turn unfinished.
+     */
+    wait(turn: TurnRef, opts?: {
+        timeoutMs?: number;
+    }): Promise<TurnRecord>;
+    /** The steps the agent took, in order. Recorded only when the message set `recordTrajectory`. */
+    trajectory(turn: TurnRef): Promise<TrajectoryStep[]>;
+    /** The screen before step `index` (the last one is after the turn), as JPEG bytes. */
+    screenshot(turn: TurnRef, index: number): Promise<Uint8Array>;
+}

package/dist/turns.js

@@ -0,0 +1,50 @@
+/**
+ * Turns: what a message to Sai started or joined. Every message gets a turn id
+ * (`turn.id`); this reads the turn's record: status, output, evidence, usage,
+ * and its trajectory when the message set `recordTrajectory`.
+ *
+ * Maps to `/v1/agents/turns/*`.
+ */
+import { waitTurnRecord } from './sessions.js';
+import { parseTrajectoryStep, parseTurnRecord, } from './types.js';
+const idOf = (turn) => {
+    const id = typeof turn === 'string' ? turn : turn.id;
+    if (!id)
+        throw new Error('This turn has no id: the message was answered without starting one.');
+    return encodeURIComponent(id);
+};
+export class Turns {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /** The turn's record now. Never waits: `finalizing` while the result is worked out. */
+    async get(turn) {
+        return parseTurnRecord(await this.http.json('GET', `/v1/agents/turns/${idOf(turn)}`));
+    }
+    /**
+     * Read the turn until it is `succeeded`, `failed` or `needs_input`. On
+     * `needs_input`, answer the approval on the turn's session
+     * (`sai.sessions.resume(record.sessionId)`) and wait again. `timeoutMs`
+     * throws a `TimeoutError` (DOMException) with the turn unfinished.
+     */
+    async wait(turn, opts = {}) {
+        const deadline = opts.timeoutMs === undefined ? null : Date.now() + opts.timeoutMs;
+        return waitTurnRecord(this.http, decodeURIComponent(idOf(turn)), deadline, [
+            'succeeded',
+            'failed',
+            'needs_input',
+        ]);
+    }
+    /** The steps the agent took, in order. Recorded only when the message set `recordTrajectory`. */
+    async trajectory(turn) {
+        const d = await this.http.json('GET', `/v1/agents/turns/${idOf(turn)}/trajectory`);
+        return (d.steps ?? []).map(parseTrajectoryStep);
+    }
+    /** The screen before step `index` (the last one is after the turn), as JPEG bytes. */
+    async screenshot(turn, index) {
+        const res = await this.http.request('GET', `/v1/agents/turns/${idOf(turn)}/trajectory/screenshots/${index}`);
+        return new Uint8Array(await res.arrayBuffer());
+    }
+}
+//# sourceMappingURL=turns.js.map

package/dist/turns.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"turns.js","sourceRoot":"","sources":["../src/turns.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,EACL,mBAAmB,EACnB,eAAe,GAGhB,MAAM,YAAY,CAAA;AAKnB,MAAM,IAAI,GAAG,CAAC,IAAa,EAAU,EAAE;IACrC,MAAM,EAAE,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAA;IACpD,IAAI,CAAC,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAA;IAC/F,OAAO,kBAAkB,CAAC,EAAE,CAAC,CAAA;AAC/B,CAAC,CAAA;AAED,MAAM,OAAO,KAAK;IACa;IAA7B,YAA6B,IAAU;QAAV,SAAI,GAAJ,IAAI,CAAM;IAAG,CAAC;IAE3C,uFAAuF;IACvF,KAAK,CAAC,GAAG,CAAC,IAAa;QACrB,OAAO,eAAe,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,oBAAoB,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;IACvF,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,IAAa,EAAE,OAA+B,EAAE;QACzD,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,SAAS,CAAA;QAClF,OAAO,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,EAAE;YACzE,WAAW;YACX,QAAQ;YACR,aAAa;SACd,CAAC,CAAA;IACJ,CAAC;IAED,iGAAiG;IACjG,KAAK,CAAC,UAAU,CAAC,IAAa;QAC5B,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAC5B,KAAK,EACL,oBAAoB,IAAI,CAAC,IAAI,CAAC,aAAa,CAC5C,CAAA;QACD,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAA;IACjD,CAAC;IAED,sFAAsF;IACtF,KAAK,CAAC,UAAU,CAAC,IAAa,EAAE,KAAa;QAC3C,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CACjC,KAAK,EACL,oBAAoB,IAAI,CAAC,IAAI,CAAC,2BAA2B,KAAK,EAAE,CACjE,CAAA;QACD,OAAO,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,WAAW,EAAE,CAAC,CAAA;IAChD,CAAC;CACF"}

package/dist/types.d.ts

@@ -0,0 +1,345 @@
+/**
+ * Response objects. Each keeps the server's JSON in `raw`, so a field the SDK
+ * does not model yet is still reachable.
+ */
+type Json = Record<string, unknown>;
+export interface Account {
+    userId: string;
+    planId: string | null;
+    planTitle: string;
+    free: boolean;
+    unlimited: boolean;
+    /** Spendable credit in USD; null on the unlimited plan or when billing could not be reached. */
+    creditsUsd: number | null;
+    raw: Json;
+}
+export declare function parseAccount(d: Json): Account;
+export interface Model {
+    id: string;
+    name: string;
+    provider: string;
+    tier: string;
+    costTier: string;
+    allowed: boolean;
+    raw: Json;
+}
+export declare function parseModel(d: Json): Model;
+export interface Machine {
+    id: string;
+    name: string | null;
+    /** `cloud` (hosted by Simular) or `own` (a desktop with the Sai app). */
+    kind: string;
+    /** True when a message can reach it now (a hibernated cloud computer wakes on the first message). */
+    online: boolean;
+    /**
+     * `running`, `starting`, `asleep`, `creating` or `unknown`; `null` on servers that do not
+     * send it yet. Prefer it over `status`.
+     */
+    state: string | null;
+    /** @deprecated The server's internal lifecycle value; it may gain values at any time. Use `state`. */
+    status: string | null;
+    canWake: boolean;
+    raw: Json;
+}
+export declare function parseMachine(d: Json): Machine;
+/** One of your customers under an Organisation. */
+export interface Tenant {
+    id: string;
+    name: string;
+    /** Your id for the customer. Unique in the Organisation; set on create only. */
+    externalId: string | null;
+    metadata: Record<string, string>;
+    /** `active` or `disabled`. */
+    status: string;
+    /** Unix time in milliseconds. */
+    createdAt: number;
+    disabledAt: number | null;
+    machineCount: number;
+    raw: Json;
+}
+export declare function parseTenant(d: Json): Tenant;
+export interface TenantPage {
+    tenants: Tenant[];
+    /** Pass as `cursor` for the next page; null on the last page. */
+    nextCursor: string | null;
+}
+/** A Tenant's own computer, running the Sai runtime. */
+export interface TenantMachine {
+    id: string;
+    name: string | null;
+    platform: string | null;
+    status: string;
+    /** True when the machine reported in the last 3 minutes. */
+    online: boolean;
+    lastSeen: number | null;
+    runtimeVersion: string | null;
+    raw: Json;
+}
+export declare function parseTenantMachine(d: Json): TenantMachine;
+export interface Enrollment {
+    /** Single use. Treat it as a secret until the Sai runtime redeems it. */
+    token: string;
+    /** Unix time in milliseconds, 15 minutes after it was created. */
+    expiresAt: number;
+    raw: Json;
+}
+export declare function parseEnrollment(d: Json): Enrollment;
+export interface TenantToken {
+    /** Pass as `new Sai({ apiKey })` to act as the Tenant on sessions, machines and turns. */
+    token: string;
+    /** Unix time in milliseconds, an hour after the exchange. There is no refresh: exchange again. */
+    expiresAt: number;
+    tenantId: string;
+    raw: Json;
+}
+export declare function parseTenantToken(d: Json): TenantToken;
+/** A file uploaded with `sai.files.upload()`. Pass it in `attachments`. */
+export interface Attachment {
+    fileId: string;
+    name: string;
+    mime: string;
+    size: number;
+    raw: Json;
+}
+export declare function parseAttachment(d: Json): Attachment;
+/** A view-only Guacamole stream of a computer's screen. The URL carries a token: keep it private. */
+export interface LiveView {
+    machineId: string;
+    websocketUrl: string;
+    width: number;
+    height: number;
+}
+/** Sai is waiting for permission (or for an answer to a choice question). */
+export interface Approval {
+    id: string;
+    title: string;
+    description: string;
+    /** `exec`, `choice`, ...; a `choice` needs `selections` when approved. */
+    type: string;
+    /** True: a human must answer in a browser at `url`; the API cannot. */
+    isLinkOnly: boolean;
+    url: string | null;
+    command: string | null;
+    questions: Json[];
+    raw: Json;
+}
+export declare function parseApproval(d: Json): Approval;
+export interface Usage {
+    inputTokens: number;
+    outputTokens: number;
+    cacheReadTokens: number;
+    cacheWriteTokens: number;
+    costUsd: number;
+    modelCalls: number;
+    byModel: Json;
+}
+export declare function parseUsage(d: unknown): Usage | null;
+/** The SDK's event kinds. `other` only appears with `events({ raw: true })`. */
+export declare const EVENT_KINDS: readonly ["step", "message", "approval", "tool_error", "error", "finished", "other"];
+export type EventKind = (typeof EVENT_KINDS)[number];
+/**
+ * One thing that happened in a turn. `kind` is the SDK's name; `type` is the
+ * wire type.
+ */
+export interface Event {
+    kind: EventKind;
+    type: string;
+    text: string | null;
+    approval: Approval | null;
+    /** `insufficient_credits` / `free_computer_time_exhausted` on errors: stop retrying today. */
+    code: string | null;
+    raw: Json;
+}
+export declare function parseEvent(d: Json): Event;
+/** Turn statuses: `running` while polling, then one of the three below. */
+export declare const TURN_STATUSES: readonly ["running", "idle", "needs_approval", "error"];
+export type TurnStatus = (typeof TURN_STATUSES)[number];
+/**
+ * Where a turn stopped. `status` is `idle` (done: `text` is the answer),
+ * `error`, or `needs_approval` (waiting on `approval`; answer it and call
+ * `wait()` again). `record` is the turn's record for a structured message (one
+ * with `inputs`, `outputSchema` or `successCriteria`).
+ */
+export interface TurnResult {
+    status: TurnStatus;
+    text: string;
+    sessionId: string;
+    approval: Approval | null;
+    error: string | null;
+    errorCode: string | null;
+    usage: Usage | null;
+    sessionUsage: Usage | null;
+    record: TurnRecord | null;
+    /** Idle, and for a structured message, the turn succeeded. */
+    ok: boolean;
+}
+/** One yes/no constraint a structured message's turn is checked against after it ends. */
+export interface Check {
+    /** Letters, digits, `_` or `-`; at most 64 characters. */
+    id: string;
+    check: string;
+    /** Also return one sentence of evidence for this check (an extra model call). */
+    returnEvidence?: boolean;
+}
+/** The verdict on one success criterion. */
+export interface Evidence {
+    /** The check's id; null for a natural-language `successCriteria`. */
+    id: string | null;
+    passed: boolean;
+    /** The probability that the check holds (`Check` criteria only). */
+    score: number | null;
+    /** Always for a natural-language criteria; for a `Check`, only with `returnEvidence`. */
+    evidence: string | null;
+}
+/** Turn record statuses, from `GET /v1/agents/turns/{id}`. */
+export declare const TURN_RECORD_STATUSES: readonly ["running", "needs_input", "finalizing", "succeeded", "failed"];
+export type TurnRecordStatus = (typeof TURN_RECORD_STATUSES)[number];
+/**
+ * A turn's record. `status` is `running`, `needs_input` (an approval or
+ * question is pending), `finalizing` (the agent is done; output and checks are
+ * being worked out), `succeeded` or `failed`. On `failed`, `reasonCode` says
+ * why: `agent_error` (with `errorCode` when known), `machine_unavailable`,
+ * `not_started`, and for a structured message `output_invalid` (see `rawAnswer`
+ * and `outputErrors`), `criteria_not_met` or `criteria_unchecked`.
+ */
+export interface TurnRecord {
+    id: string;
+    sessionId: string | null;
+    machineId: string;
+    status: TurnRecordStatus;
+    /** The agent's final text; with `outputSchema`, an object matching it. */
+    output: unknown;
+    reasonCode: string | null;
+    rawAnswer: string | null;
+    /** `insufficient_credits` or `free_computer_time_exhausted`, for a known `agent_error`. */
+    errorCode: string | null;
+    outputErrors: string[];
+    /** Empty for a plain message. */
+    evidence: Evidence[];
+    /** Tokens of every model call the agent made in the turn. */
+    usage: Usage | null;
+    recordTrajectory: boolean;
+    /** At least one step was stored (`sai.turns.trajectory()`). */
+    trajectoryRecorded: boolean;
+    template: string | null;
+    inputs: Json | null;
+    /** True when `idempotencyKey` matched an earlier turn: this is that turn, and nothing was sent. */
+    replayed: boolean;
+    done: boolean;
+    ok: boolean;
+    raw: Json;
+}
+export declare function parseTurnRecord(d: Json): TurnRecord;
+/** One step the agent took: what it did, and why. Fetch its screen with `sai.turns.screenshot()`. */
+export interface TrajectoryStep {
+    index: number;
+    /** The screenshot taken when the turn ended, after the last step. */
+    final: boolean;
+    timestamp: string;
+    title: string | null;
+    code: string | null;
+    /** The agent's text before the action. */
+    rationale: string | null;
+    error: string | null;
+    hasScreenshot: boolean;
+    raw: Json;
+}
+export declare function parseTrajectoryStep(d: Json): TrajectoryStep;
+export interface ExecError {
+    /** `exception`, `timeout` or `interrupted`. */
+    kind: string;
+    message: string;
+    stack: string | null;
+}
+/** What one Simulang block returned. A block that threw is still a result: check `error`. */
+export interface ExecResult {
+    result: unknown;
+    logs: string[];
+    error: ExecError | null;
+    /** The screenshot the block captured (page/app snapshot, pageContent), decoded. */
+    screenshot: Uint8Array | null;
+    /** `image/jpeg` or `image/png`. */
+    screenshotMimeType: string | null;
+    /** @deprecated Use `screenshot`. Not always PNG; see `screenshotMimeType`. */
+    screenshotPng?: Uint8Array | null;
+    screenshotOmitted: boolean;
+    variables: Json[];
+    durationMs: number;
+    ok: boolean;
+    raw: Json;
+}
+export declare function parseExecResult(d: Json): ExecResult;
+/** One input of learned code: a `{{name}}` in the template and a key of `main`'s `params`. */
+export interface LearnParameter {
+    name: string;
+    defaultValue: string;
+    description: string | null;
+}
+/** How learned code did on one run, for `sai.learn.create(..., { initialCode, evaluations })`. */
+export interface Evaluation {
+    inputs: Record<string, string | number | boolean>;
+    /** The run's result from `lease.exec()` / `lease.run()`; its screenshot is not sent. */
+    result?: ExecResult;
+    /** A judgement of the run, or its id. */
+    judgement?: Judgement | string;
+    passed?: boolean;
+    note?: string;
+}
+/**
+ * The result of `sai.learn.create()`: Simulang code made from recorded turns, or a repair of
+ * code you sent. Run it with `lease.run(learned, inputs)`. Research preview.
+ */
+export interface LearnResult {
+    id: string;
+    /** `convert` (code from turns) or `heal` (a repair of `initialCode`). */
+    mode: 'convert' | 'heal';
+    /** `failed` when the code still has `validation.errors`, or the request failed (`error`). */
+    status: 'succeeded' | 'failed' | 'running';
+    title: string | null;
+    /** The task with `{{name}}` placeholders: send it to `session.send()` with `inputs` to run it with the agent. */
+    template: string | null;
+    parameters: LearnParameter[];
+    /** `async function main(params = { ... })`. */
+    code: string;
+    outputSchema: Json | null;
+    validation: {
+        errors: string[];
+        warnings: string[];
+    };
+    /** For `heal`: what changed and why. */
+    changes: string | null;
+    sourceTurns: string[];
+    usage: Usage | null;
+    /** The error code when the request failed, e.g. `trajectory_not_recorded`. */
+    error: string | null;
+    /** True when `idempotencyKey` matched an earlier call: this is that call's result. */
+    replayed: boolean;
+    ok: boolean;
+    raw: Json;
+}
+export declare function parseLearnResult(d: Json): LearnResult;
+/** The verdict on one criterion of a judgement. */
+export interface CriterionResult {
+    /** The check's id; null for a natural-language criteria. */
+    id: string | null;
+    check: string;
+    /** `unverifiable` when the record cannot show it. */
+    verdict: 'passed' | 'failed' | 'unverifiable';
+    score: number | null;
+    evidence: string | null;
+}
+/** The result of `sai.judge.create()`. It never changes the turns it judged. Research preview. */
+export interface Judgement {
+    id: string;
+    verdict: 'passed' | 'failed' | 'unverifiable' | null;
+    summary: string | null;
+    task: string | null;
+    criteria: CriterionResult[];
+    turns: string[];
+    usage: Usage | null;
+    replayed: boolean;
+    ok: boolean;
+    raw: Json;
+}
+export declare function parseJudgement(d: Json): Judgement;
+export {};