@gitterm/sdk 0.1.2 → 0.2.0

package/dist/direct/runs.d.ts

@@ -0,0 +1,19 @@
+import { GittermError } from "../errors.js";
+import type { AgentRunReply, RunWatchOptions } from "../types.js";
+import type { DirectRun, DirectRunMessage, DirectWorkspace } from "./types.js";
+export declare function directError(error: unknown): GittermError;
+export declare function directRunOperations(assertWorkspace: (workspace: DirectWorkspace) => void, fetchImpl?: typeof fetch): {
+    messages(run: DirectRun): Promise<DirectRunMessage[]>;
+    cancel(run: DirectRun): Promise<{
+        cancelled: boolean;
+    }>;
+    events: (ref: DirectRun, options?: RunWatchOptions) => AsyncIterable<import("../types.js").AgentRunEvent<DirectRun>>;
+    wait: (ref: DirectRun, options?: import("../types.js").RunWaitOptions) => Promise<DirectRun>;
+    result: (ref: DirectRun, options?: import("../types.js").RunResultOptions) => Promise<import("../types.js").AgentRunResult<DirectRun>>;
+    get: (run: DirectRun) => Promise<DirectRun>;
+    watch: (run: DirectRun, options?: RunWatchOptions) => AsyncGenerator<DirectRun>;
+    respond: (run: DirectRun, input: {
+        requestId: string;
+        reply: AgentRunReply;
+    }) => Promise<DirectRun>;
+};

package/dist/direct/types.d.ts

@@ -1,3 +1,4 @@
+import type { AgentRun, AgentRunMessage, OpencodeApi, RunWaitOptions } from "../types.js";
 export type DirectWorkspaceLifecycle = "ephemeral" | "persistent";
 export type DirectWorkspaceStatus = "pending" | "running" | "paused" | "failed" | "terminated" | "unknown";
 export type DirectProviderCapabilities = {
@@ -10,13 +11,13 @@ export type DirectProviderCapabilities = {
 };
 export type DirectApiModelCredential = {
     providerName: string;
-    type?: "api";
+    source: "apiKey";
     apiKey: string;
     metadata?: Record<string, string>;
 };
 export type DirectOAuthModelCredential = {
     providerName: string;
-    type: "oauth";
+    source: "oauth";
     refreshToken: string;
     /** May be omitted when OpenCode should refresh immediately. */
     accessToken?: string;
@@ -131,7 +132,11 @@ export type DirectWorkspaceCreateInput = {
     };
     lifecycle?: DirectWorkspaceLifecycle;
     environmentVariables?: Record<string, string>;
-    modelCredentials?: DirectModelCredential[];
+    models?: {
+        default?: string;
+        inherit?: "none";
+        providers?: Record<string, Omit<DirectApiModelCredential, "providerName"> | Omit<DirectOAuthModelCredential, "providerName">>;
+    };
     setup?: DirectWorkspaceSetup;
     secretFiles?: DirectSecretFile[];
     /** Provider-specific attachment settings. */
@@ -141,6 +146,8 @@ export type DirectWorkspaceCreateInput = {
     /** Trusted integration context appended to the generated global AGENTS.md. */
     additionalAgentInstructions?: string;
     opencode?: {
+        /** Defaults to v1. v2 requires a compatible provider image/template. */
+        api?: OpencodeApi;
         config?: Record<string, unknown>;
         plugins?: string[];
         skills?: Array<{
@@ -162,6 +169,7 @@ export type DirectWorkspace = {
     status: DirectWorkspaceStatus;
     lifecycle: DirectWorkspaceLifecycle;
     runtime: DirectWorkspaceRuntime;
+    opencodeApi: OpencodeApi;
     setup: "not_requested" | "before_agent_complete" | "after_agent";
     createdAt: string;
 };
@@ -293,27 +301,21 @@ export type DirectRunCreateInput = {
     title?: string;
     agent?: string;
     model?: string;
-    /** Reuse this native OpenCode session for conversational context. */
-    sessionId?: string;
+    context?: {
+        type: "isolated";
+    } | {
+        type: "continue";
+        run: DirectRun;
+    };
+    waitForSetup?: boolean;
+    setupTimeoutMs?: number;
+    signal?: AbortSignal;
 };
-export type DirectRun = {
-    id: string;
-    workspaceId: string;
+/** Contains runtime credentials. Encrypt when persisting; do not send to an untrusted UI. */
+export type DirectRun = AgentRun & {
+    workspace: DirectWorkspace;
     sessionId: string;
     messageId: string;
-    title: string;
-    status: "running" | "retrying" | "completed" | "failed" | "cancelled";
-    error: string | null;
-    finalText: string | null;
-    submittedAt: string;
-};
-export type DirectRunMessage = {
-    id: string;
-    role: "user" | "assistant";
-    text: string;
-    error: string | null;
-};
-export type DirectRunWaitOptions = {
-    timeoutMs?: number;
-    pollIntervalMs?: number;
 };
+export type DirectRunMessage = AgentRunMessage;
+export type DirectRunWaitOptions = RunWaitOptions;

package/dist/errors.d.ts

@@ -1,6 +1,8 @@
-export type GittermErrorCode = "NOT_LOGGED_IN" | "UNAUTHORIZED" | "NOT_FOUND" | "FORBIDDEN" | "BAD_REQUEST" | "CONFLICT" | "SERVER_ERROR" | "NETWORK" | CredentialErrorCode | WorkspaceLifecycleErrorCode;
+import type { AgentRun } from "./types.js";
+export type GittermErrorCode = "NOT_LOGGED_IN" | "UNAUTHORIZED" | "NOT_FOUND" | "FORBIDDEN" | "BAD_REQUEST" | "CONFLICT" | "SERVER_ERROR" | "NETWORK" | "ABORTED" | "TIMEOUT" | "INPUT_NOT_PENDING" | "INPUT_REQUIRED" | "RUN_FAILED" | "RUN_CANCELLED" | CredentialErrorCode | WorkspaceLifecycleErrorCode;
 export type CredentialErrorCode = "MODEL_CREDENTIAL_UNAVAILABLE" | "MODEL_CREDENTIAL_DUPLICATE_PROVIDER" | "MODEL_CREDENTIAL_INVALID" | "MODEL_CREDENTIAL_REQUIRED";
-export type WorkspaceLifecycleErrorCode = "WORKSPACE_TERMINATED" | "WORKSPACE_NON_RECOVERABLE" | "WORKSPACE_START_TIMEOUT" | "WORKSPACE_RESTART_FAILED";
+export type WorkspaceLifecycleErrorCode = "WORKSPACE_NOT_RUNNING" | "WORKSPACE_TERMINATED" | "WORKSPACE_NON_RECOVERABLE" | "WORKSPACE_START_TIMEOUT" | "WORKSPACE_RESTART_FAILED";
+export declare const WORKSPACE_LIFECYCLE_ERROR_CODES: readonly WorkspaceLifecycleErrorCode[];
 export declare class GittermError extends Error {
     readonly code: GittermErrorCode;
     readonly cause?: unknown;
@@ -14,3 +16,8 @@ export declare class WorkspaceLifecycleError extends GittermError {
         cause?: unknown;
     });
 }
+/** result() could not produce a successful result. The run remains inspectable. */
+export declare class AgentRunError<T extends AgentRun = AgentRun> extends GittermError {
+    readonly run: T;
+    constructor(run: T, code: "INPUT_REQUIRED" | "RUN_FAILED" | "RUN_CANCELLED");
+}

package/dist/index.d.ts

@@ -3,7 +3,7 @@ export { DEFAULT_GITTERM_SERVER_URL, getConfigPath, loadConfig, loadConfigSync,
 export type { CliConfig } from "./config.js";
 export { loginWithDeviceCode } from "./device-login.js";
 export type { DeviceCodeInfo, LoginWithDeviceCodeOptions } from "./device-login.js";
-export { GittermError, WorkspaceLifecycleError } from "./errors.js";
+export { AgentRunError, GittermError, WorkspaceLifecycleError } from "./errors.js";
 export { createGittermWorkspaceClient, getWorkspaceEnvironment, type GittermWorkspaceClient, type WorkspaceClientOptions, type WorkspaceEnvironment, type WorkspacePort, type WorkspaceSelf, } from "./workspace-client.js";
 export type { CredentialErrorCode, GittermErrorCode, WorkspaceLifecycleErrorCode, } from "./errors.js";
-export type { AgentRun, AgentRunCreateInput, AgentRunMessage, AgentRunStatus, AgentType, AgentKey, AuthStatus, BuiltInAgentKey, CloudProvider, ProviderKey, Workspace, WorkspaceCreateInput, WorkspaceCreateResult, WorkspaceCatalog, WorkspaceEnsureRunningResult, WorkspaceHostingType, WorkspaceListOptions, WorkspaceListResult, WorkspaceRestartResult, WorkspaceRuntimeAccess, WorkspaceStatus, WorkspaceSetupStatus, ModelCredential, ModelProviderInfo, WorkspaceModelCredentialInput, WorkspacePauseResult, WorkspaceTerminateResult, WorkspaceProviderSelection, } from "./types.js";
+export type { AgentPermissionRequest, AgentQuestion, AgentQuestionOption, AgentQuestionRequest, AgentRun, AgentRunCreateInput, AgentRunInputRequest, AgentRunMessage, AgentRunMessagePart, AgentRunReply, AgentRunStatus, AgentRunEvent, AgentRunResult, AgentRunReplyPermission, AgentRunReplyQuestion, RunResultOptions, RunRef, RunWaitOptions, RunWatchOptions, OpencodeApi, AgentType, AgentKey, AuthStatus, BuiltInAgentKey, CloudProvider, ProviderKey, Workspace, WorkspaceCreateInput, WorkspaceCreateResult, WorkspaceCatalog, WorkspaceEnsureRunningResult, WorkspaceHostingType, WorkspaceListOptions, WorkspaceListResult, WorkspaceRestartResult, WorkspaceRuntimeAccess, WorkspaceStatus, WorkspaceSetupStatus, ModelCredential, ModelProviderInfo, ModelInfo, ModelCredentialSource, WorkspaceModelsInput, WorkspaceModelAccess, WorkspacePauseResult, WorkspaceTerminateResult, WorkspaceProviderSelection, } from "./types.js";