computesdk 1.0.0 → 1.0.1

package/README.md

@@ -1,185 +0,0 @@
-# ComputeSDK Documentation
-
-The ComputeSDK provides a powerful interface for interacting with remote compute environments, enabling terminal access, file operations, and process execution in a secure containerized environment.
-
-## Installation
-
-```bash
-npm install computesdk
-# or
-yarn add computesdk
-# or
-pnpm add computesdk
-```
-
-## Quick Start
-
-```javascript
-import { ComputeClient } from 'computesdk';
-
-async function main() {
-  // Create a new compute client
-  const client = new ComputeClient();
-  
-  // Create a new compute instance
-  const compute = await client.create();
-  
-  // Listen for server ready events
-  compute.onServerReady((port, url) => {
-    console.log(`Server is ready on port ${port} at ${url}`);
-  });
-}
-```
-
-## Core Components
-
-### ComputeClient
-
-The main entry point for creating and managing compute instances.
-
-```javascript
-const client = new ComputeClient({
-  baseUrl: 'https://api.computesdk.com' // Optional, defaults to this value
-});
-```
-
-Methods:
-- `create()`: Creates a new compute instance and returns a `Compute` object
-  ```javascript
-  // Create a new compute instance
-  const compute = await client.create();
-  
-  // The returned compute object provides:
-  // - WebSocket connection to the compute environment
-  // - Terminal operations
-  // - File system operations
-  // - Process execution capabilities
-  
-  // Returns: Promise<Compute>
-  // Throws: Error if compute creation fails
-  ```
-
-- `delete(computeId)`: Terminates and removes a compute instance
-  ```javascript
-  // Delete a specific compute instance
-  await client.delete(compute.computeId);
-  
-  // Parameters:
-  // - computeId: string (required) - The ID of the compute instance to delete
-  
-  // Returns: Promise<void>
-  // Throws: Error if deletion fails or computeId is invalid
-  ```
-
-Note: It's recommended to use the `compute.teardown()` method instead of calling `delete()` directly, as it properly closes WebSocket connections and handles cleanup.
-
-### Compute
-
-Represents a compute instance with capabilities for file management, terminal operations, and process execution.
-
-#### File Operations
-
-```javascript
-// Watch files for changes
-const watcher = compute.watchFiles({
-  path: '/home/project',
-  includeContent: false,    // Optional: include file contents in change events
-  ignored: ['**/node_modules/**']  // Optional: patterns to ignore
-});
-
-watcher.onChanged(data => console.log('File changed:', data));
-
-// Read file contents
-const content = await compute.readFile('/path/to/file');
-
-// Write to a file
-await compute.writeFile('/path/to/file', 'content');
-
-// Create directories
-await compute.mkdir('/path/to/dir', { 
-  recursive: true  // Optional: create parent directories if they don't exist
-});
-
-// Delete files
-await compute.deleteFile('/path/to/file');
-```
-
-#### Terminal Operations
-
-```javascript
-// Create a new terminal
-const terminal = await compute.createTerminal({
-  rows: 24,     // Optional
-  cols: 80,     // Optional
-  command: null, // Optional
-  args: []      // Optional
-});
-
-// Terminal event handlers
-terminal.onData(data => console.log('Received:', data));
-terminal.onExit(({ exitCode, signal }) => console.log('Terminal exited'));
-
-// Send input to terminal
-terminal.write('echo "Hello World"\n');
-
-// Resize terminal
-terminal.resize(100, 30);
-```
-
-#### Process Execution
-
-```javascript
-// Execute commands
-const result = await compute.exec('npm install');
-```
-
-#### Event Handlers
-
-```javascript
-// Connection events
-compute.onConnected(() => console.log('Connected to compute instance'));
-compute.onError(error => console.error('Error:', error));
-
-// Port and server events
-compute.onPortOpened((port, url) => console.log(`Port ${port} opened at ${url}`));
-compute.onServerReady((port, url) => console.log(`Server ready on port ${port} at ${url}`));
-```
-
-## WebSocket Communication
-
-The SDK uses WebSocket connections for real-time communication with compute instances. It automatically handles:
-- Secure WebSocket connections (wss:// for https, ws:// for http)
-- Connection retries (up to 3 attempts with exponential backoff)
-- Automatic reconnection on unexpected disconnections
-
-## Debug Mode
-
-Enable debug logging by setting localStorage.DEBUG to 'true' in the browser:
-
-```javascript
-localStorage.setItem('DEBUG', 'true');
-```
-
-## Cleanup
-
-To properly clean up resources:
-
-```javascript
-await compute.teardown(); // Closes WebSocket and deletes compute instance
-```
-
-## Security Notes
-
-- The SDK automatically handles secure WebSocket connections when using HTTPS
-- All file paths should be properly sanitized before use
-- Node modules are automatically ignored in file watching operations
-- The SDK includes automatic cleanup on window unload in browser environments
-
-## Error Handling
-
-The SDK provides comprehensive error handling through:
-- Promise rejections for async operations
-- Error events through the onError handler
-- Detailed console logging in debug mode
-
-For more information and advanced usage, please refer to the API documentation or contact support.