@kubb/studio 5.3.17 → 5.3.18

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import { t as __name } from "./rolldown-runtime-CRm0XQPb.js";
 import { AGENT_INSTANCE_HEADER, AgentApi, AgentCapacity, AgentCloseCode, AgentLoad, AgentPermissions, AgentRegisterInput, AgentRegisterResponse, ConfigEdit, ConnectMessagePayload, GenerateInput, GenerateResult, GenerationEvent, GenerationEventPayloads, GenerationEventType, GenerationRun, PublishSnapshotInput, PublishSnapshotResult, RpcClose, RpcConnection, RpcConnector, StudioApi, generationEventTypes } from "./protocol.js";
 import { Config, Hookable, KubbHooks } from "@kubb/core";
 import { Storage } from "unstorage";
-//#region src/api.d.ts
+//#region src/operations/api.d.ts
 /**
  * Thrown when Studio rejects the agent token itself (401). Retrying cannot help: the token was
  * revoked, or the agent it belonged to was deleted in the Studio UI. Hosts catch this to forget
@@ -117,7 +117,7 @@ type StudioJob = {
  * const finished = await waitForJob({ studioUrl, token, id: job.id })
  * ```
  */
-export declare function createJob({ studioUrl, token, type, agentId, name, version, commit, baseId, config, timeoutMs, signal }: {
+export declare function createJob({ studioUrl, token, type, agentId, name, version, commit, baseId, config, instanceId, timeoutMs, signal }: {
   studioUrl: string;
   token: string;
   type: 'generation' | 'snapshot';
@@ -129,6 +129,11 @@ export declare function createJob({ studioUrl, token, type, agentId, name, versi
   /** The `id` another CI agent's runs register under, such as the base branch's; this snapshot is also compared with its latest one. */
   baseId?: string;
   config?: Record<string, unknown>;
+  /**
+   * The agent process to run the job on, the `instanceId` its client connected with. A CI run passes
+   * its own, so an overlapping pipeline under the same CI agent never builds its checkout.
+   */
+  instanceId?: string;
   /**
    * How long to keep retrying a busy or queue-full response before giving up, in milliseconds.
    *
@@ -190,7 +195,7 @@ export declare function createAgent({ studioUrl, token, name, machineToken }: {
   machineToken: string;
 }): Promise<StudioAgent>;
 //#endregion
-//#region src/StudioSession.d.ts
+//#region src/runtime/StudioSession.d.ts
 type StudioSessionOptions = {
   connector?: RpcConnector;
   token: string;
@@ -230,7 +235,7 @@ type StudioSessionOptions = {
   heartbeatInterval?: number;
   /**
    * What this agent process can take on, reported to Studio at registration. Unset fields come from
-   * `KUBB_AGENT_MAX_CONCURRENT` and `KUBB_AGENT_MEMORY_BUDGET_MB`.
+   * `KUBB_AGENT_MAX_CONCURRENT`.
    */
   capacity?: Partial<AgentCapacity>;
   /**
@@ -259,8 +264,8 @@ type StudioSessionOptions = {
   onTokenRejected?: (error: InvalidAgentTokenError) => void;
 };
 //#endregion
-//#region src/client.d.ts
-type ClientOptions = Omit<StudioSessionOptions, 'signal' | 'onTokenRejected' | 'instanceId' | 'reconnectAttempt'> & {
+//#region src/runtime/client.d.ts
+type ClientOptions = Omit<StudioSessionOptions, 'signal' | 'onTokenRejected' | 'reconnectAttempt'> & {
   /**
    * Called once when the token is rejected during a background reconnect (401: revoked, or the
    * agent was deleted). The client is already stopped by the time this fires, so a host only needs
@@ -297,7 +302,7 @@ type Client = {
  */
 export declare function createClient({ onAuthRequired, ...options }: ClientOptions): Client;
 //#endregion
-//#region src/hooks.d.ts
+//#region src/operations/hooks.d.ts
 /**
  * Events a host emits about its Kubb Studio session, as opposed to a generation. `kubb:` stays
  * reserved for generation lifecycle.
@@ -403,14 +408,14 @@ declare global {
   }
 }
 //#endregion
-//#region src/constants.d.ts
+//#region src/operations/constants.d.ts
 /**
  * Hosted Kubb Studio URL. Exported so credential stores can bind tokens to the resolved instance,
  * not whatever default the client would pick on its own.
  */
 export declare const defaultStudioUrl = "https://kubb.studio";
 //#endregion
-//#region src/machine.d.ts
+//#region src/operations/machine.d.ts
 /**
  * Installs the storage driver the runtime persists to. Call once, before connecting.
  */
@@ -426,7 +431,7 @@ export declare function createFileStorage(base: string): Storage;
  */
 export declare function machineTokenFrom(secret: string): string;
 //#endregion
-//#region src/runConnection.d.ts
+//#region src/runtime/runConnection.d.ts
 /**
  * Why a connection ended: the host asked it to stop through its `signal`, or the host declined to
  * replace a rejected token.
@@ -494,7 +499,7 @@ export declare function runConnection<TCredentials extends {
   token: string;
 }>({ credentials, clientOptions, onTokenRejected, signal }: ConnectionOptions<TCredentials>): Promise<ConnectionOutcome>;
 //#endregion
-//#region src/pair.d.ts
+//#region src/operations/pair.d.ts
 /**
  * RFC 8628 device-authorization response from Studio's `/api/auth/device/code` endpoint.
  * Field names match the RFC; the CLI polls with `device_code` and shows `user_code` to the user.
@@ -609,7 +614,7 @@ type PairAgentOptions = StartPairingOptions & {
  */
 export declare function pairAgent({ onCode, onRetry, maxAttempts, ...options }: PairAgentOptions): Promise<PairingResult>;
 //#endregion
-//#region src/rpc.d.ts
+//#region src/operations/rpc.d.ts
 /**
  * Opens an authenticated Cap'n Web session to Studio over a WebSocket. Rejects an unencrypted URL
  * before opening the socket, so a bearer token never reaches a plaintext host.