rl-rock 1.2.5 → 1.2.6

package/dist/index.d.mts

@@ -490,18 +490,6 @@ declare const RunMode: {
     NORMAL: "normal";
     NOHUP: "nohup";
 };
-/**
- * Constants class (deprecated, use envs module instead)
- * @deprecated Use envs module instead
- */
-declare class Constants {
-    static readonly BASE_URL_PRODUCT = "";
-    static readonly BASE_URL_ALIYUN = "";
-    static readonly BASE_URL_INNER = "";
-    static readonly BASE_URL_PRE = "";
-    static readonly BASE_URL_LOCAL = "";
-    static readonly REQUEST_TIMEOUT_SECONDS = 180;
-}
 /**
  * PID prefix and suffix for nohup output parsing
  */
@@ -554,6 +542,10 @@ declare function raiseForCode(code: Codes | null | undefined, message: string):
  */
 declare function fromRockException(e: RockException): SandboxResponse;
 
+/**
+ * HTTP utilities using axios
+ */
+
 /**
  * HTTP response with headers
  */
@@ -633,9 +625,6 @@ declare function sleep(ms: number): Promise<void>;
  */
 declare function withRetry<T extends (...args: unknown[]) => Promise<unknown>>(fn: T, options?: RetryOptions): T;
 
-/**
- * Deprecated decorator utilities
- */
 /**
  * Mark a function as deprecated
  */
@@ -647,17 +636,17 @@ declare function deprecatedClass(reason?: string): <T extends new (...args: any[
 
 /**
  * System utilities
+ *
+ * Note: This SDK requires Node.js environment (v20.8.0+).
+ * It cannot run in browsers due to dependencies on Node.js modules.
  */
 /**
  * Check if running in Node.js environment
  */
 declare function isNode(): boolean;
-/**
- * Check if running in browser environment
- */
-declare function isBrowser(): boolean;
 /**
  * Get environment variable
+ * Directly accesses process.env since this SDK requires Node.js
  */
 declare function getEnv(key: string, defaultValue?: string): string | undefined;
 /**
@@ -666,6 +655,7 @@ declare function getEnv(key: string, defaultValue?: string): string | undefined;
 declare function getRequiredEnv(key: string): string;
 /**
  * Check if environment variable is set
+ * Directly checks process.env since this SDK requires Node.js
  */
 declare function isEnvSet(key: string): boolean;
 
@@ -801,8 +791,18 @@ declare class RockEnv {
     private readonly envId;
     private sandboxId;
     private isClosed;
-    private client;
-    constructor(config: RockEnvConfig);
+    private constructor();
+    /**
+     * Create and initialize a RockEnv instance
+     *
+     * @param config - Environment configuration
+     * @returns Initialized RockEnv instance
+     */
+    static create(config: RockEnvConfig): Promise<RockEnv>;
+    /**
+     * Get the sandbox ID
+     */
+    getSandboxId(): string | null;
     /**
      * Initialize environment instance
      */
@@ -848,9 +848,9 @@ declare class RockEnv {
  *
  * @param envId - Environment ID
  * @param options - Environment options
- * @returns RockEnv instance
+ * @returns Promise resolving to RockEnv instance
  */
-declare function make(envId: string, options?: Record<string, unknown>): RockEnv;
+declare function make(envId: string, options?: Record<string, unknown>): Promise<RockEnv>;
 
 /**
  * Sandbox configuration
@@ -1058,7 +1058,7 @@ declare class LinuxFileSystem extends FileSystem {
 }
 
 /**
- * Sandbox types
+ * Network - Network management for sandbox
  */
 
 /**
@@ -1069,11 +1069,6 @@ declare enum SpeedupType {
     PIP = "pip",
     GITHUB = "github"
 }
-
-/**
- * Network - Network management for sandbox
- */
-
 /**
  * Network management for sandbox
  */
@@ -2361,4 +2356,4 @@ declare class DefaultAgent extends Agent {
  */
 declare const VERSION: string;
 
-export { Agent, type AgentBashCommand, AgentBashCommandSchema, type AgentConfig, AgentConfigSchema, BadRequestRockError, type BaseConfig, type BashAction, BashActionSchema, type ChmodRequest, ChmodRequestSchema, type ChmodResponse, ChmodResponseSchema, type ChownRequest, ChownRequestSchema, type ChownResponse, ChownResponseSchema, type CloseResponse, CloseResponseSchema, type CloseSessionRequest, CloseSessionRequestSchema, type CloseSessionResponse, CloseSessionResponseSchema, Codes, type Command, type CommandResponse, CommandResponseSchema, CommandRockError, CommandSchema, Constants, type CreateBashSessionRequest, CreateBashSessionRequestSchema, type CreateSessionResponse, CreateSessionResponseSchema, DefaultAgent, type DefaultAgentConfig, DefaultAgentConfigSchema, Deploy, EnvHubClient, type EnvHubClientConfig, EnvHubClientConfigSchema, EnvHubError, type ExecuteBashSessionResponse, ExecuteBashSessionResponseSchema, HttpUtils, InternalServerRockError, InvalidParameterRockException, type IsAliveResponse, IsAliveResponseSchema, LinuxFileSystem, LinuxRemoteUser, ModelClient, type ModelClientConfig, ModelService, type ModelServiceConfig, ModelServiceConfigSchema, NODE_DEFAULT_VERSION, Network, NodeRuntimeEnv, type NodeRuntimeEnvConfig, NodeRuntimeEnvConfigSchema, type Observation, ObservationSchema, type OssSetupResponse, OssSetupResponseSchema, PID_PREFIX, PID_SUFFIX, type PollOptions, Process, PythonRuntimeEnv, type PythonRuntimeEnvConfig, PythonRuntimeEnvConfigSchema, type ReadFileRequest, ReadFileRequestSchema, type ReadFileResponse, ReadFileResponseSchema, ReasonPhrases, type ResetResult, type RockAgentConfig, RockAgentConfigSchema, RockEnv, type RockEnvConfig, type RockEnvInfo, RockEnvInfoSchema, RockException, RunMode, type RunModeType, RuntimeEnv, type RuntimeEnvConfig, RuntimeEnvConfigSchema, type RuntimeEnvId, Sandbox, type SandboxConfig, SandboxConfigSchema, SandboxGroup, type SandboxGroupConfig, SandboxGroupConfigSchema, type SandboxLike, type SandboxResponse, SandboxResponseSchema, type RunModeType as SandboxRunModeType, type SandboxStatusResponse, SandboxStatusResponseSchema, SpeedupType, type StepResult, type UploadRequest, UploadRequestSchema, type UploadResponse, UploadResponseSchema, VERSION, type WriteFileRequest, WriteFileRequestSchema, type WriteFileResponse, WriteFileResponseSchema, arunWithRetry, createRockEnvInfo, createRuntimeEnvId, createSandboxConfig, createSandboxGroupConfig, deprecated, deprecatedClass, extractNohupPid as extractNohupPidFromSandbox, fromRockException, getDefaultPipIndexUrl, getEnv, getReasonPhrase, getRequiredEnv, isBrowser, isClientError, isCommandError, isEnvSet, isError, isNode, isServerError, isSuccess, make, raiseForCode, retryAsync, sleep, withRetry, withTimeLogging };
+export { Agent, type AgentBashCommand, AgentBashCommandSchema, type AgentConfig, AgentConfigSchema, BadRequestRockError, type BaseConfig, type BashAction, BashActionSchema, type ChmodRequest, ChmodRequestSchema, type ChmodResponse, ChmodResponseSchema, type ChownRequest, ChownRequestSchema, type ChownResponse, ChownResponseSchema, type CloseResponse, CloseResponseSchema, type CloseSessionRequest, CloseSessionRequestSchema, type CloseSessionResponse, CloseSessionResponseSchema, Codes, type Command, type CommandResponse, CommandResponseSchema, CommandRockError, CommandSchema, type CreateBashSessionRequest, CreateBashSessionRequestSchema, type CreateSessionResponse, CreateSessionResponseSchema, DefaultAgent, type DefaultAgentConfig, DefaultAgentConfigSchema, Deploy, EnvHubClient, type EnvHubClientConfig, EnvHubClientConfigSchema, EnvHubError, type ExecuteBashSessionResponse, ExecuteBashSessionResponseSchema, HttpUtils, InternalServerRockError, InvalidParameterRockException, type IsAliveResponse, IsAliveResponseSchema, LinuxFileSystem, LinuxRemoteUser, ModelClient, type ModelClientConfig, ModelService, type ModelServiceConfig, ModelServiceConfigSchema, NODE_DEFAULT_VERSION, Network, NodeRuntimeEnv, type NodeRuntimeEnvConfig, NodeRuntimeEnvConfigSchema, type Observation, ObservationSchema, type OssSetupResponse, OssSetupResponseSchema, PID_PREFIX, PID_SUFFIX, type PollOptions, Process, PythonRuntimeEnv, type PythonRuntimeEnvConfig, PythonRuntimeEnvConfigSchema, type ReadFileRequest, ReadFileRequestSchema, type ReadFileResponse, ReadFileResponseSchema, ReasonPhrases, type ResetResult, type RockAgentConfig, RockAgentConfigSchema, RockEnv, type RockEnvConfig, type RockEnvInfo, RockEnvInfoSchema, RockException, RunMode, type RunModeType, RuntimeEnv, type RuntimeEnvConfig, RuntimeEnvConfigSchema, type RuntimeEnvId, Sandbox, type SandboxConfig, SandboxConfigSchema, SandboxGroup, type SandboxGroupConfig, SandboxGroupConfigSchema, type SandboxLike, type SandboxResponse, SandboxResponseSchema, type RunModeType as SandboxRunModeType, type SandboxStatusResponse, SandboxStatusResponseSchema, SpeedupType, type StepResult, type UploadRequest, UploadRequestSchema, type UploadResponse, UploadResponseSchema, VERSION, type WriteFileRequest, WriteFileRequestSchema, type WriteFileResponse, WriteFileResponseSchema, arunWithRetry, createRockEnvInfo, createRuntimeEnvId, createSandboxConfig, createSandboxGroupConfig, deprecated, deprecatedClass, extractNohupPid as extractNohupPidFromSandbox, fromRockException, getDefaultPipIndexUrl, getEnv, getReasonPhrase, getRequiredEnv, isClientError, isCommandError, isEnvSet, isError, isNode, isServerError, isSuccess, make, raiseForCode, retryAsync, sleep, withRetry, withTimeLogging };

package/dist/index.d.ts

@@ -490,18 +490,6 @@ declare const RunMode: {
     NORMAL: "normal";
     NOHUP: "nohup";
 };
-/**
- * Constants class (deprecated, use envs module instead)
- * @deprecated Use envs module instead
- */
-declare class Constants {
-    static readonly BASE_URL_PRODUCT = "";
-    static readonly BASE_URL_ALIYUN = "";
-    static readonly BASE_URL_INNER = "";
-    static readonly BASE_URL_PRE = "";
-    static readonly BASE_URL_LOCAL = "";
-    static readonly REQUEST_TIMEOUT_SECONDS = 180;
-}
 /**
  * PID prefix and suffix for nohup output parsing
  */
@@ -554,6 +542,10 @@ declare function raiseForCode(code: Codes | null | undefined, message: string):
  */
 declare function fromRockException(e: RockException): SandboxResponse;
 
+/**
+ * HTTP utilities using axios
+ */
+
 /**
  * HTTP response with headers
  */
@@ -633,9 +625,6 @@ declare function sleep(ms: number): Promise<void>;
  */
 declare function withRetry<T extends (...args: unknown[]) => Promise<unknown>>(fn: T, options?: RetryOptions): T;
 
-/**
- * Deprecated decorator utilities
- */
 /**
  * Mark a function as deprecated
  */
@@ -647,17 +636,17 @@ declare function deprecatedClass(reason?: string): <T extends new (...args: any[
 
 /**
  * System utilities
+ *
+ * Note: This SDK requires Node.js environment (v20.8.0+).
+ * It cannot run in browsers due to dependencies on Node.js modules.
  */
 /**
  * Check if running in Node.js environment
  */
 declare function isNode(): boolean;
-/**
- * Check if running in browser environment
- */
-declare function isBrowser(): boolean;
 /**
  * Get environment variable
+ * Directly accesses process.env since this SDK requires Node.js
  */
 declare function getEnv(key: string, defaultValue?: string): string | undefined;
 /**
@@ -666,6 +655,7 @@ declare function getEnv(key: string, defaultValue?: string): string | undefined;
 declare function getRequiredEnv(key: string): string;
 /**
  * Check if environment variable is set
+ * Directly checks process.env since this SDK requires Node.js
  */
 declare function isEnvSet(key: string): boolean;
 
@@ -801,8 +791,18 @@ declare class RockEnv {
     private readonly envId;
     private sandboxId;
     private isClosed;
-    private client;
-    constructor(config: RockEnvConfig);
+    private constructor();
+    /**
+     * Create and initialize a RockEnv instance
+     *
+     * @param config - Environment configuration
+     * @returns Initialized RockEnv instance
+     */
+    static create(config: RockEnvConfig): Promise<RockEnv>;
+    /**
+     * Get the sandbox ID
+     */
+    getSandboxId(): string | null;
     /**
      * Initialize environment instance
      */
@@ -848,9 +848,9 @@ declare class RockEnv {
  *
  * @param envId - Environment ID
  * @param options - Environment options
- * @returns RockEnv instance
+ * @returns Promise resolving to RockEnv instance
  */
-declare function make(envId: string, options?: Record<string, unknown>): RockEnv;
+declare function make(envId: string, options?: Record<string, unknown>): Promise<RockEnv>;
 
 /**
  * Sandbox configuration
@@ -1058,7 +1058,7 @@ declare class LinuxFileSystem extends FileSystem {
 }
 
 /**
- * Sandbox types
+ * Network - Network management for sandbox
  */
 
 /**
@@ -1069,11 +1069,6 @@ declare enum SpeedupType {
     PIP = "pip",
     GITHUB = "github"
 }
-
-/**
- * Network - Network management for sandbox
- */
-
 /**
  * Network management for sandbox
  */
@@ -2361,4 +2356,4 @@ declare class DefaultAgent extends Agent {
  */
 declare const VERSION: string;
 
-export { Agent, type AgentBashCommand, AgentBashCommandSchema, type AgentConfig, AgentConfigSchema, BadRequestRockError, type BaseConfig, type BashAction, BashActionSchema, type ChmodRequest, ChmodRequestSchema, type ChmodResponse, ChmodResponseSchema, type ChownRequest, ChownRequestSchema, type ChownResponse, ChownResponseSchema, type CloseResponse, CloseResponseSchema, type CloseSessionRequest, CloseSessionRequestSchema, type CloseSessionResponse, CloseSessionResponseSchema, Codes, type Command, type CommandResponse, CommandResponseSchema, CommandRockError, CommandSchema, Constants, type CreateBashSessionRequest, CreateBashSessionRequestSchema, type CreateSessionResponse, CreateSessionResponseSchema, DefaultAgent, type DefaultAgentConfig, DefaultAgentConfigSchema, Deploy, EnvHubClient, type EnvHubClientConfig, EnvHubClientConfigSchema, EnvHubError, type ExecuteBashSessionResponse, ExecuteBashSessionResponseSchema, HttpUtils, InternalServerRockError, InvalidParameterRockException, type IsAliveResponse, IsAliveResponseSchema, LinuxFileSystem, LinuxRemoteUser, ModelClient, type ModelClientConfig, ModelService, type ModelServiceConfig, ModelServiceConfigSchema, NODE_DEFAULT_VERSION, Network, NodeRuntimeEnv, type NodeRuntimeEnvConfig, NodeRuntimeEnvConfigSchema, type Observation, ObservationSchema, type OssSetupResponse, OssSetupResponseSchema, PID_PREFIX, PID_SUFFIX, type PollOptions, Process, PythonRuntimeEnv, type PythonRuntimeEnvConfig, PythonRuntimeEnvConfigSchema, type ReadFileRequest, ReadFileRequestSchema, type ReadFileResponse, ReadFileResponseSchema, ReasonPhrases, type ResetResult, type RockAgentConfig, RockAgentConfigSchema, RockEnv, type RockEnvConfig, type RockEnvInfo, RockEnvInfoSchema, RockException, RunMode, type RunModeType, RuntimeEnv, type RuntimeEnvConfig, RuntimeEnvConfigSchema, type RuntimeEnvId, Sandbox, type SandboxConfig, SandboxConfigSchema, SandboxGroup, type SandboxGroupConfig, SandboxGroupConfigSchema, type SandboxLike, type SandboxResponse, SandboxResponseSchema, type RunModeType as SandboxRunModeType, type SandboxStatusResponse, SandboxStatusResponseSchema, SpeedupType, type StepResult, type UploadRequest, UploadRequestSchema, type UploadResponse, UploadResponseSchema, VERSION, type WriteFileRequest, WriteFileRequestSchema, type WriteFileResponse, WriteFileResponseSchema, arunWithRetry, createRockEnvInfo, createRuntimeEnvId, createSandboxConfig, createSandboxGroupConfig, deprecated, deprecatedClass, extractNohupPid as extractNohupPidFromSandbox, fromRockException, getDefaultPipIndexUrl, getEnv, getReasonPhrase, getRequiredEnv, isBrowser, isClientError, isCommandError, isEnvSet, isError, isNode, isServerError, isSuccess, make, raiseForCode, retryAsync, sleep, withRetry, withTimeLogging };
+export { Agent, type AgentBashCommand, AgentBashCommandSchema, type AgentConfig, AgentConfigSchema, BadRequestRockError, type BaseConfig, type BashAction, BashActionSchema, type ChmodRequest, ChmodRequestSchema, type ChmodResponse, ChmodResponseSchema, type ChownRequest, ChownRequestSchema, type ChownResponse, ChownResponseSchema, type CloseResponse, CloseResponseSchema, type CloseSessionRequest, CloseSessionRequestSchema, type CloseSessionResponse, CloseSessionResponseSchema, Codes, type Command, type CommandResponse, CommandResponseSchema, CommandRockError, CommandSchema, type CreateBashSessionRequest, CreateBashSessionRequestSchema, type CreateSessionResponse, CreateSessionResponseSchema, DefaultAgent, type DefaultAgentConfig, DefaultAgentConfigSchema, Deploy, EnvHubClient, type EnvHubClientConfig, EnvHubClientConfigSchema, EnvHubError, type ExecuteBashSessionResponse, ExecuteBashSessionResponseSchema, HttpUtils, InternalServerRockError, InvalidParameterRockException, type IsAliveResponse, IsAliveResponseSchema, LinuxFileSystem, LinuxRemoteUser, ModelClient, type ModelClientConfig, ModelService, type ModelServiceConfig, ModelServiceConfigSchema, NODE_DEFAULT_VERSION, Network, NodeRuntimeEnv, type NodeRuntimeEnvConfig, NodeRuntimeEnvConfigSchema, type Observation, ObservationSchema, type OssSetupResponse, OssSetupResponseSchema, PID_PREFIX, PID_SUFFIX, type PollOptions, Process, PythonRuntimeEnv, type PythonRuntimeEnvConfig, PythonRuntimeEnvConfigSchema, type ReadFileRequest, ReadFileRequestSchema, type ReadFileResponse, ReadFileResponseSchema, ReasonPhrases, type ResetResult, type RockAgentConfig, RockAgentConfigSchema, RockEnv, type RockEnvConfig, type RockEnvInfo, RockEnvInfoSchema, RockException, RunMode, type RunModeType, RuntimeEnv, type RuntimeEnvConfig, RuntimeEnvConfigSchema, type RuntimeEnvId, Sandbox, type SandboxConfig, SandboxConfigSchema, SandboxGroup, type SandboxGroupConfig, SandboxGroupConfigSchema, type SandboxLike, type SandboxResponse, SandboxResponseSchema, type RunModeType as SandboxRunModeType, type SandboxStatusResponse, SandboxStatusResponseSchema, SpeedupType, type StepResult, type UploadRequest, UploadRequestSchema, type UploadResponse, UploadResponseSchema, VERSION, type WriteFileRequest, WriteFileRequestSchema, type WriteFileResponse, WriteFileResponseSchema, arunWithRetry, createRockEnvInfo, createRuntimeEnvId, createSandboxConfig, createSandboxGroupConfig, deprecated, deprecatedClass, extractNohupPid as extractNohupPidFromSandbox, fromRockException, getDefaultPipIndexUrl, getEnv, getReasonPhrase, getRequiredEnv, isClientError, isCommandError, isEnvSet, isError, isNode, isServerError, isSuccess, make, raiseForCode, retryAsync, sleep, withRetry, withTimeLogging };