@kubb/studio 5.3.4 → 5.3.6

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { t as __name } from "./rolldown-runtime-CRm0XQPb.js";
-import { AgentPermissions, ClientInfo, createJobId } from "./protocol.js";
+import { AgentApi, AgentPermissions, ClientInfo, ConfigEdit, ConnectMessagePayload, GenerateInput, GenerateResult, GenerationEvent, GenerationEventPayloads, GenerationEventType, GenerationRun, PublishSnapshotInput, PublishSnapshotResult, RpcConnection, RpcConnector, StudioApi, generationEventTypes } from "./protocol.js";
 import { Config, Hookable, KubbHooks } from "@kubb/core";
 import { Storage } from "unstorage";
 //#region src/api.d.ts
@@ -14,7 +14,7 @@ export declare class InvalidAgentTokenError extends Error {
 /**
  * Status values returned by Studio's jobs API.
  */
-type StudioJobStatus = 'queued' | 'running' | 'success' | 'failed';
+type StudioJobStatus = 'queued' | 'running' | 'success' | 'failed' | 'canceled';
 /**
  * Package view returned on a successful snapshot job from Studio.
  */
@@ -57,7 +57,7 @@ type StudioJob = {
    */
   id: string;
   /**
-   * Current status. Poll until `success` or `failed`.
+   * Current status. Poll until `success`, `failed`, or `canceled`.
    */
   status: StudioJobStatus;
   /**
@@ -98,7 +98,7 @@ export declare function createJob({ studioUrl, token, type, agentId, name, versi
   config?: Record<string, unknown>;
 }): Promise<StudioJob>;
 /**
- * Polls `GET /api/jobs/{id}` until the job reaches `success` or `failed`, waiting
+ * Polls `GET /api/jobs/{id}` until the job reaches a terminal status, waiting
  * {@link INITIAL_POLL_DELAY_MS} first and doubling up to {@link MAX_POLL_INTERVAL_MS} so a long
  * job stays inside the API key's rate limit.
  *
@@ -151,6 +151,7 @@ export declare function createAgent({ studioUrl, token, name, machineToken }: {
 //#endregion
 //#region src/StudioSession.d.ts
 type StudioSessionOptions = {
+  connector?: RpcConnector;
   token: string;
   studioUrl?: string;
   configPath: string;
@@ -526,5 +527,18 @@ type PollOptions = {
  */
 export declare function pollForPairingToken({ studioUrl, session, signal }: PollOptions): Promise<PairingResult>;
 //#endregion
-export { type Client, type ClientOptions, type ConnectionOptions, type StudioAgent, type StudioConnectedContext, type StudioJob, type StudioJobStatus, type StudioSnapshot, createJobId };
+//#region src/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.
+ *
+ * @example
+ * ```ts
+ * const rpc = await connectWebSocketRpc({ url: 'wss://studio.kubb.dev/s/1', token, local: session })
+ * await rpc.studio.ping()
+ * ```
+ */
+export declare const connectWebSocketRpc: RpcConnector;
+//#endregion
+export { type AgentApi, type Client, type ClientOptions, type ConfigEdit, type ConnectMessagePayload, type ConnectionOptions, type GenerateInput, type GenerateResult, type GenerationEvent, type GenerationEventPayloads, type GenerationEventType, type GenerationRun, type PublishSnapshotInput, type PublishSnapshotResult, type RpcConnection, type RpcConnector, type StudioAgent, type StudioApi, type StudioConnectedContext, type StudioJob, type StudioJobStatus, type StudioSnapshot, generationEventTypes };
 //# sourceMappingURL=index.d.ts.map