@fly/sprites/dist/types.d.ts

JavaScript/TypeScript SDK for Sprites - remote command execution

/**
 * Type definitions for the Sprites JavaScript SDK
 */
/**
 * Client configuration options
 */
export interface ClientOptions {
    /** Base URL for the Sprites API (default: https://api.sprites.dev) */
    baseURL?: string;
    /** HTTP request timeout in milliseconds (default: 30000) */
    timeout?: number;
}
/**
 * Sprite configuration options for creation
 */
export interface SpriteConfig {
    /** RAM in megabytes */
    ramMB?: number;
    /** Number of CPUs */
    cpus?: number;
    /** Region to deploy the sprite */
    region?: string;
    /** Storage in gigabytes */
    storageGB?: number;
}
/**
 * Options for spawning a command
 */
export interface SpawnOptions {
    /** Working directory for the command */
    cwd?: string;
    /** Environment variables as key-value pairs */
    env?: Record<string, string>;
    /** Enable TTY mode */
    tty?: boolean;
    /** TTY rows (height) */
    rows?: number;
    /** TTY columns (width) */
    cols?: number;
    /** Create a detachable tmux session */
    detachable?: boolean;
    /** Attach to existing session ID */
    sessionId?: string;
    /** Enable control mode (requires detachable or sessionId) */
    controlMode?: boolean;
}
/**
 * Options for exec methods
 */
export interface ExecOptions extends SpawnOptions {
    /** Encoding for output (default: 'utf8') */
    encoding?: BufferEncoding;
    /** Maximum buffer size for output (default: 10MB) */
    maxBuffer?: number;
}
/**
 * Result from exec methods
 */
export interface ExecResult {
    /** Standard output */
    stdout: string | Buffer;
    /** Standard error */
    stderr: string | Buffer;
    /** Exit code */
    exitCode: number;
}
/**
 * Sprite information from the API
 */
export interface SpriteInfo {
    /** Sprite ID */
    id: string;
    /** Sprite name */
    name: string;
    /** Organization name */
    organization: string;
    /** Current status */
    status: string;
    /** Configuration */
    config?: SpriteConfig;
    /** Environment variables */
    environment?: Record<string, string>;
    /** Creation timestamp */
    createdAt: Date;
    /** Last update timestamp */
    updatedAt: Date;
    /** Bucket name */
    bucketName?: string;
    /** Primary region */
    primaryRegion?: string;
}
/**
 * Options for listing sprites
 */
export interface ListOptions {
    /** Filter by name prefix */
    prefix?: string;
    /** Maximum number of results */
    maxResults?: number;
    /** Continuation token for pagination */
    continuationToken?: string;
}
/**
 * Paginated list of sprites
 */
export interface SpriteList {
    /** Array of sprite information */
    sprites: SpriteInfo[];
    /** Whether there are more results */
    hasMore: boolean;
    /** Token for fetching next page */
    nextContinuationToken?: string;
}
/**
 * Execution session information
 */
export interface Session {
    /** Session ID */
    id: string;
    /** Command being executed */
    command: string;
    /** Session creation time */
    created: Date;
    /** Bytes per second throughput */
    bytesPerSecond: number;
    /** Whether the session is currently active */
    isActive: boolean;
    /** Last activity timestamp */
    lastActivity?: Date;
}
/**
 * Port notification message
 */
export interface PortNotification {
    /** Notification type */
    type: 'port_opened' | 'port_closed';
    /** Port number */
    port: number;
    /** IP address */
    address: string;
    /** Process ID */
    pid: number;
}
/**
 * Organization information
 */
export interface OrganizationInfo {
    /** Organization name */
    name: string;
    /** Organization URL */
    url: string;
}
/**
 * WebSocket control message
 */
export interface ControlMessage {
    /** Message type */
    type: 'resize';
    /** Terminal columns */
    cols?: number;
    /** Terminal rows */
    rows?: number;
}
/**
 * Stream ID for the binary protocol
 */
export declare enum StreamID {
    Stdin = 0,
    Stdout = 1,
    Stderr = 2,
    Exit = 3,
    StdinEOF = 4
}
/**
 * Error thrown when a command exits with a non-zero code
 */
export declare class ExecError extends Error {
    readonly result: ExecResult;
    constructor(message: string, result: ExecResult);
    get exitCode(): number;
    get stdout(): string | Buffer;
    get stderr(): string | Buffer;
}
/**
 * Request body for creating a sprite
 */
export interface CreateSpriteRequest {
    /** Sprite name */
    name: string;
    /** Optional configuration */
    config?: SpriteConfig;
    /** Optional environment variables */
    environment?: Record<string, string>;
}
/**
 * Response from sprite creation
 */
export interface CreateSpriteResponse {
    /** Created sprite name */
    name: string;
}
//# sourceMappingURL=types.d.ts.map