@llmsafespaces/sdk 0.5.2 → 0.5.3

package/dist/index.d.ts

@@ -0,0 +1,455 @@
+/** SDK configuration options. */
+type FetchFn = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
+interface ClientOptions {
+    baseUrl: string;
+    apiKey?: string;
+    credentials?: {
+        email: string;
+        password: string;
+    };
+    timeout?: number;
+    fetch?: FetchFn;
+}
+/** Workspace resource. */
+interface Workspace {
+    id: string;
+    name: string;
+    userId: string;
+    runtime: string;
+    storageSize: string;
+    phase: string;
+    pvcName?: string;
+    labels?: Record<string, string>;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateWorkspaceRequest {
+    name?: string;
+    runtime?: string;
+    storageSize?: string;
+    storageClass?: string;
+    labels?: Record<string, string>;
+}
+interface WorkspaceListResult {
+    items: WorkspaceListItem[];
+    pagination?: PaginationMetadata;
+}
+interface WorkspaceListItem {
+    id: string;
+    name: string;
+    userId: string;
+    runtime: string;
+    storageSize: string;
+    phase?: string;
+    maxActiveSessions?: number;
+    createdAt: string;
+    updatedAt: string;
+}
+interface PaginationMetadata {
+    total: number;
+    start: number;
+    end: number;
+    limit: number;
+    offset: number;
+}
+interface WorkspaceStatusResult {
+    phase: string;
+    pvcName?: string;
+    activeSessions: number;
+    lastActivityAt?: string;
+    message?: string;
+    conditions?: WorkspaceCondition[];
+    credentialState: {
+        available: boolean;
+        reason?: string;
+        message?: string;
+    };
+    agentHealth: {
+        status: string;
+        providersConfigured: number;
+        agentVersion?: string;
+    };
+    sessions?: {
+        id: string;
+        title?: string;
+        status: string;
+    }[];
+    diskUsedBytes?: number;
+    diskTotalBytes?: number;
+}
+interface WorkspaceCondition {
+    type: string;
+    status: string;
+    reason?: string;
+    message?: string;
+}
+interface ActivateWorkspaceResponse {
+    resumed: string;
+    suspended?: string;
+}
+interface RefreshWorkspaceResult {
+    restartGeneration: number;
+}
+interface EnsureSessionResponse {
+    workspaceId: string;
+    workspacePhase: string;
+    sessionId: string;
+    resumed: boolean;
+}
+interface SessionListItem {
+    id: string;
+    title?: string;
+    lastMessageAt?: string;
+    messageCount: number;
+    status: string;
+}
+interface ActiveSessionsResponse {
+    active: string[];
+    maxActive: number;
+}
+/** Opencode message response (proxy passthrough). */
+interface MessageResponse {
+    raw: unknown;
+    content: string;
+}
+interface AuthResponse {
+    token: string;
+    user: User;
+}
+interface User {
+    id: string;
+    username: string;
+    email: string;
+    createdAt: string;
+    updatedAt: string;
+    active: boolean;
+    role: string;
+}
+interface APIKey {
+    id: string;
+    name: string;
+    key?: string;
+    prefix: string;
+    active: boolean;
+    createdAt: string;
+    expiresAt?: string;
+}
+interface TerminalTicket {
+    ticket: string;
+    expiresAt: string;
+}
+interface SecretResponse {
+    id: string;
+    name: string;
+    type: string;
+    metadata?: unknown;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Regex pattern for valid secret names. Keep in sync with pkg/validation/name.go. */
+declare const SECRET_NAME_PATTERN: RegExp;
+interface CreateSecretRequest {
+    /** Lowercase alphanumeric, dots, underscores, hyphens only. Must not start with dot or hyphen. */
+    name: string;
+    type: "api-key" | "ssh-key" | "git-credential" | "secret-file" | "env-secret";
+    value: string;
+    metadata?: unknown;
+}
+interface ProviderCredential {
+    id: string;
+    name: string;
+    kind: string;
+    slug: string;
+    baseURL?: string;
+    modelAllowlist?: string[];
+    modelContextLimits?: Record<string, number>;
+    modelOutputLimits?: Record<string, number>;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateProviderCredentialRequest {
+    name: string;
+    kind: string;
+    slug: string;
+    apiKey: string;
+    baseURL?: string;
+}
+interface UpdateProviderCredentialRequest {
+    name?: string;
+    apiKey?: string;
+    baseURL?: string;
+    modelAllowlist?: string[];
+    modelContextLimits?: Record<string, number>;
+    modelOutputLimits?: Record<string, number>;
+}
+interface QueuedMessage {
+    id: string;
+    text: string;
+    session_id: string;
+    workspace_id: string;
+    enqueued_at: string;
+    retry_count: number;
+}
+
+declare class LLMSafeSpaces {
+    private readonly baseUrl;
+    private readonly timeout;
+    private readonly fetchFn;
+    private token;
+    private apiKey;
+    private credentials;
+    private loggingIn;
+    readonly workspaces: WorkspacesAPI;
+    readonly sessions: SessionsAPI;
+    readonly auth: AuthAPI;
+    readonly secrets: SecretsAPI;
+    readonly terminal: TerminalAPI;
+    readonly userSettings: UserSettingsAPI;
+    readonly account: AccountAPI;
+    readonly providerCredentials: ProviderCredentialsAPI;
+    readonly adminProviderCredentials: AdminProviderCredentialsAPI;
+    readonly usage: UsageAPI;
+    readonly inputRequests: InputRequestsAPI;
+    readonly probe: ProbeAPI;
+    readonly prompts: PromptsAPI;
+    readonly agentRoles: AgentRolesAPI;
+    constructor(options: ClientOptions);
+    /** Internal: make an authenticated request. */
+    request<T>(method: string, path: string, body?: unknown, timeout?: number): Promise<T>;
+    private login;
+}
+declare class WorkspacesAPI {
+    private client;
+    constructor(client: LLMSafeSpaces);
+    list(limit?: number, offset?: number): Promise<WorkspaceListResult>;
+    create(req: CreateWorkspaceRequest): Promise<Workspace>;
+    get(id: string): Promise<Workspace>;
+    rename(id: string, name: string): Promise<void>;
+    delete(id: string): Promise<void>;
+    getStatus(id: string): Promise<WorkspaceStatusResult>;
+    activate(id: string): Promise<ActivateWorkspaceResponse>;
+    suspend(id: string): Promise<void>;
+    restart(id: string): Promise<void>;
+    refreshCompute(id: string): Promise<RefreshWorkspaceResult>;
+    setBindings(id: string, secretIds: string[]): Promise<void>;
+    getBindings(id: string): Promise<{
+        bindings: Array<{
+            id: string;
+            name: string;
+            type: string;
+        }>;
+    }>;
+    reloadSecrets(id: string): Promise<{
+        reloaded: number;
+        restarted: boolean;
+    }>;
+    setModel(id: string, model: string): Promise<void>;
+    getModels(id: string): Promise<{
+        models: unknown[];
+        currentModel: string;
+    }>;
+    setEnv(id: string, env: Record<string, string>): Promise<void>;
+    getEnv(id: string): Promise<{
+        vars: string[];
+    }>;
+    deleteEnv(id: string, varName: string): Promise<void>;
+}
+declare class SessionsAPI {
+    private client;
+    constructor(client: LLMSafeSpaces);
+    ensure(workspaceId: string): Promise<EnsureSessionResponse>;
+    list(workspaceId: string): Promise<SessionListItem[]>;
+    getActive(workspaceId: string): Promise<ActiveSessionsResponse>;
+    rename(workspaceId: string, sessionId: string, title: string): Promise<void>;
+    sendMessage(workspaceId: string, sessionId: string, content: string): Promise<MessageResponse>;
+    getHistory(workspaceId: string, sessionId: string): Promise<unknown[]>;
+    abort(workspaceId: string, sessionId: string): Promise<void>;
+    get(workspaceId: string, sessionId: string): Promise<Record<string, unknown>>;
+    sendPromptAsync(workspaceId: string, sessionId: string, message: string): Promise<void>;
+    delete(workspaceId: string, sessionId: string): Promise<void>;
+    enqueue(workspaceId: string, sessionId: string, text: string): Promise<{
+        messageID: string;
+    }>;
+    listQueue(workspaceId: string, sessionId: string): Promise<{
+        messages: QueuedMessage[];
+    }>;
+    dismissQueued(workspaceId: string, sessionId: string, messageId: string): Promise<void>;
+    markSeen(workspaceId: string, sessionId: string): Promise<void>;
+}
+declare class AuthAPI {
+    private client;
+    constructor(client: LLMSafeSpaces);
+    me(): Promise<User>;
+    listApiKeys(): Promise<APIKey[]>;
+    createApiKey(name: string): Promise<APIKey>;
+    deleteApiKey(id: string): Promise<void>;
+}
+declare class SecretsAPI {
+    private client;
+    constructor(client: LLMSafeSpaces);
+    create(req: CreateSecretRequest): Promise<SecretResponse>;
+    list(): Promise<any>;
+    get(id: string): Promise<SecretResponse>;
+    update(id: string, value: string): Promise<void>;
+    delete(id: string): Promise<void>;
+    reveal(id: string, password: string): Promise<{
+        value: string;
+    }>;
+    getAuditLog(): Promise<{
+        entries: unknown[];
+    }>;
+    getBindingsForSecret(id: string): Promise<{
+        workspaces: string[];
+    }>;
+}
+declare class TerminalAPI {
+    private client;
+    constructor(client: LLMSafeSpaces);
+    getTicket(workspaceId: string): Promise<TerminalTicket>;
+}
+declare class UserSettingsAPI {
+    private client;
+    constructor(client: LLMSafeSpaces);
+    get(): Promise<{
+        settings: Record<string, unknown>;
+        schemaVersion: number;
+    }>;
+    getSchema(): Promise<{
+        settings: unknown[];
+        schemaVersion: number;
+    }>;
+    set(key: string, value: unknown): Promise<{
+        key: string;
+        value: unknown;
+    }>;
+}
+declare class AccountAPI {
+    private client;
+    constructor(client: LLMSafeSpaces);
+    rotateKey(password: string): Promise<{
+        keyVersion: number;
+        recoveryKey: string;
+    }>;
+    changePassword(oldPassword: string, newPassword: string): Promise<void>;
+    recover(userId: string, recoveryKey: string, newPassword: string): Promise<{
+        recoveryKey: string;
+    }>;
+}
+declare class ProviderCredentialsAPI {
+    private client;
+    constructor(client: LLMSafeSpaces);
+    create(req: CreateProviderCredentialRequest): Promise<ProviderCredential>;
+    list(): Promise<ProviderCredential[]>;
+    get(id: string): Promise<ProviderCredential>;
+    delete(id: string): Promise<void>;
+    probeModels(id: string): Promise<{
+        models: unknown[];
+    }>;
+    listBindings(id: string): Promise<string[]>;
+    bind(credId: string, workspaceId: string): Promise<unknown>;
+    unbind(credId: string, workspaceId: string): Promise<void>;
+}
+declare class AdminProviderCredentialsAPI {
+    private client;
+    constructor(client: LLMSafeSpaces);
+    list(): Promise<ProviderCredential[]>;
+    create(req: CreateProviderCredentialRequest): Promise<ProviderCredential>;
+    get(id: string): Promise<ProviderCredential>;
+    update(id: string, req: UpdateProviderCredentialRequest): Promise<ProviderCredential>;
+    delete(id: string): Promise<void>;
+    probeModels(id: string): Promise<{
+        models: unknown[];
+    }>;
+    createAutoApply(id: string, req: {
+        targetType: string;
+        targetId?: string;
+        withinPriority?: number;
+    }): Promise<unknown>;
+    listAutoApply(id: string): Promise<unknown[]>;
+    deleteAutoApply(id: string, targetType: string, targetId: string): Promise<void>;
+}
+declare class UsageAPI {
+    private client;
+    constructor(client: LLMSafeSpaces);
+    get(): Promise<Record<string, unknown>>;
+    getWorkspace(workspaceId: string): Promise<Record<string, unknown>>;
+    getQuota(): Promise<Record<string, unknown>>;
+}
+declare class InputRequestsAPI {
+    private client;
+    constructor(client: LLMSafeSpaces);
+    listQuestions(workspaceId: string): Promise<unknown[]>;
+    replyQuestion(workspaceId: string, requestId: string, body: Record<string, unknown>): Promise<void>;
+    rejectQuestion(workspaceId: string, requestId: string): Promise<void>;
+    listPermissions(workspaceId: string): Promise<unknown[]>;
+    replyPermission(workspaceId: string, requestId: string, body: Record<string, unknown>): Promise<void>;
+}
+declare class ProbeAPI {
+    private client;
+    constructor(client: LLMSafeSpaces);
+    probeModels(apiKey: string, baseURL: string): Promise<{
+        models: unknown[];
+    }>;
+}
+declare class PromptsAPI {
+    private client;
+    constructor(client: LLMSafeSpaces);
+    getPlatform(): Promise<{
+        prompt: string;
+    }>;
+    setPlatform(prompt: string): Promise<void>;
+    getOrg(orgId: string): Promise<{
+        prompt: string;
+        allowUserPrompt: boolean;
+    }>;
+    setOrg(orgId: string, body: {
+        prompt?: string;
+        allowUserPrompt?: boolean;
+    }): Promise<void>;
+    getWorkspace(workspaceId: string): Promise<{
+        prompt: string;
+    }>;
+    setWorkspace(workspaceId: string, prompt: string): Promise<void>;
+}
+declare class AgentRolesAPI {
+    private client;
+    constructor(client: LLMSafeSpaces);
+    listPlatform(): Promise<unknown[]>;
+    createPlatform(body: Record<string, unknown>): Promise<unknown>;
+    getPlatform(roleId: string): Promise<unknown>;
+    updatePlatform(roleId: string, body: Record<string, unknown>): Promise<unknown>;
+    deletePlatform(roleId: string): Promise<void>;
+    listOrg(orgId: string): Promise<unknown[]>;
+    createOrg(orgId: string, body: Record<string, unknown>): Promise<unknown>;
+    getOrg(orgId: string, roleId: string): Promise<unknown>;
+    updateOrg(orgId: string, roleId: string, body: Record<string, unknown>): Promise<unknown>;
+    deleteOrg(orgId: string, roleId: string): Promise<void>;
+    getWorkspaceRole(workspaceId: string): Promise<unknown>;
+    setWorkspaceRole(workspaceId: string, roleId: string): Promise<void>;
+    clearWorkspaceRole(workspaceId: string): Promise<void>;
+    getEffectiveWorkspaceRole(workspaceId: string): Promise<unknown>;
+}
+
+/** Base error for all LLMSafeSpaces API errors. */
+declare class LLMSafeSpacesError extends Error {
+    readonly status: number;
+    readonly code?: string | undefined;
+    constructor(message: string, status: number, code?: string | undefined);
+}
+declare class AuthError extends LLMSafeSpacesError {
+    constructor(message: string, status?: number);
+}
+declare class NotFoundError extends LLMSafeSpacesError {
+    constructor(message: string);
+}
+declare class ConflictError extends LLMSafeSpacesError {
+    constructor(message: string);
+}
+declare class TimeoutError extends LLMSafeSpacesError {
+    constructor(message?: string);
+}
+declare class RateLimitError extends LLMSafeSpacesError {
+    constructor(message?: string);
+}
+
+export { type APIKey, type ActivateWorkspaceResponse, type ActiveSessionsResponse, AuthError, type AuthResponse, type ClientOptions, ConflictError, type CreateProviderCredentialRequest, type CreateSecretRequest, type CreateWorkspaceRequest, type EnsureSessionResponse, type FetchFn, LLMSafeSpaces, LLMSafeSpacesError, type MessageResponse, NotFoundError, type PaginationMetadata, type ProviderCredential, type QueuedMessage, RateLimitError, type RefreshWorkspaceResult, SECRET_NAME_PATTERN, type SecretResponse, type SessionListItem, type TerminalTicket, TimeoutError, type UpdateProviderCredentialRequest, type User, type Workspace, type WorkspaceCondition, type WorkspaceListItem, type WorkspaceListResult, type WorkspaceStatusResult };