@daytonaio/sdk 0.19.0-alpha.0 → 0.19.0-alpha.3

package/README.md

@@ -0,0 +1,145 @@
+# Daytona SDK for TypeScript
+
+A TypeScript SDK for interacting with the Daytona API, providing a simple interface for Daytona Sandbox management, Git operations, file system operations, and language server protocol support.
+
+## Installation
+
+You can install the package using npm:
+
+```bash
+npm install @daytonaio/sdk
+```
+
+Or using yarn:
+
+```bash
+yarn add @daytonaio/sdk
+```
+
+## Quick Start
+
+Here's a simple example of using the SDK:
+
+```typescript
+import { Daytona } from '@daytonaio/sdk'
+
+// Initialize using environment variables
+const daytona = new Daytona()
+
+// Create a sandbox
+const sandbox = await daytona.create()
+
+// Run code in the sandbox
+const response = await sandbox.process.codeRun('console.log("Hello World!")')
+console.log(response.result)
+
+// Clean up when done
+await daytona.delete(sandbox)
+```
+
+## Configuration
+
+The SDK can be configured using environment variables or by passing a configuration object:
+
+```typescript
+import { Daytona } from '@daytonaio/sdk'
+
+// Initialize with configuration
+const daytona = new Daytona({
+  apiKey: 'your-api-key',
+  apiUrl: 'your-api-url',
+  target: 'us',
+})
+```
+
+Or using environment variables:
+
+- `DAYTONA_API_KEY`: Your Daytona API key
+- `DAYTONA_API_URL`: The Daytona API URL
+- `DAYTONA_TARGET`: Your target environment
+
+You can also customize sandbox creation:
+
+```typescript
+const sandbox = await daytona.create({
+  language: 'typescript',
+  envVars: { NODE_ENV: 'development' },
+  autoStopInterval: 60, // Auto-stop after 1 hour of inactivity
+})
+```
+
+## Features
+
+- **Sandbox Management**: Create, manage and remove sandboxes
+- **Git Operations**: Clone repositories, manage branches, and more
+- **File System Operations**: Upload, download, search and manipulate files
+- **Language Server Protocol**: Interact with language servers for code intelligence
+- **Process Management**: Execute code and commands in sandboxes
+
+## Examples
+
+### Execute Commands
+
+```typescript
+// Execute a shell command
+const response = await sandbox.process.executeCommand('echo "Hello, World!"')
+console.log(response.result)
+
+// Run TypeScript code
+const response = await sandbox.process.codeRun(`
+const x = 10
+const y = 20
+console.log(\`Sum: \${x + y}\`)
+`)
+console.log(response.result)
+```
+
+### File Operations
+
+```typescript
+// Upload a file
+await sandbox.fs.uploadFile(Buffer.from('Hello, World!'), 'path/to/file.txt')
+
+// Download a file
+const content = await sandbox.fs.downloadFile('path/to/file.txt')
+
+// Search for files
+const matches = await sandbox.fs.findFiles(root_dir, 'search_pattern')
+```
+
+### Git Operations
+
+```typescript
+// Clone a repository
+await sandbox.git.clone('https://github.com/example/repo', 'path/to/clone')
+
+// List branches
+const branches = await sandbox.git.branches('path/to/repo')
+
+// Add files
+await sandbox.git.add('path/to/repo', ['file1.txt', 'file2.txt'])
+```
+
+### Language Server Protocol
+
+```typescript
+// Create and start a language server
+const lsp = await sandbox.createLspServer('typescript', 'path/to/project')
+await lsp.start()
+
+// Notify the lsp for the file
+await lsp.didOpen('path/to/file.ts')
+
+// Get document symbols
+const symbols = await lsp.documentSymbols('path/to/file.ts')
+
+// Get completions
+const completions = await lsp.completions('path/to/file.ts', {
+  line: 10,
+  character: 15,
+})
+```
+
+## Contributing
+
+Daytona is Open Source under the [GNU AFFERO GENERAL PUBLIC LICENSE](LICENSE), and is the [copyright of its contributors](NOTICE). If you would like to contribute to the software, read the Developer Certificate of Origin Version 1.1 (https://developercertificate.org/). Afterwards, navigate to the [contributing guide](CONTRIBUTING.md) to get started.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@daytonaio/sdk",
-  "version": "0.19.0-alpha.0",
+  "version": "0.19.0-alpha.3",
   "description": "TypeScript SDK for Daytona",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",
@@ -18,35 +18,40 @@
     "docsDir": "../../apps/docs/content/sdk-typescript"
   },
   "scripts": {
-    "build": "tsc && tsc -p tsconfig.esm.json",
+    "build": "tsc",
+    "prepare": "npm run build",
     "docs": "bash -O extglob -c 'rm -rf $npm_package_config_docsDir/!(index.mdx)' && typedoc && rm -f $npm_package_config_docsDir/readme.mdx"
   },
   "files": [
     "dist"
   ],
   "keywords": [],
+  "devDependencies": {
+    "@babel/preset-env": "^7.22.0",
+    "@babel/preset-typescript": "^7.22.0",
+    "@types/jest": "^29.5.0",
+    "@types/node": "^22.10.0",
+    "@types/shell-quote": "^1.7.5",
+    "@types/tar": "^6.1.13",
+    "jest": "^29.5.0",
+    "ts-jest": "^29.1.0",
+    "typedoc": "~0.27.7",
+    "typedoc-plugin-markdown": "~4.4.2",
+    "typedoc-plugin-merge-modules": "~6.1.0",
+    "typescript": "^5.0.0"
+  },
   "dependencies": {
+    "@daytonaio/api-client": "^0.19.1",
     "@aws-sdk/client-s3": "^3.445.0",
     "@aws-sdk/lib-storage": "^3.798.0",
-    "@babel/preset-env": "7.27.2",
-    "@babel/preset-typescript": "7.27.1",
-    "@daytonaio/api-client": "^0.19.0-alpha.3",
     "@dotenvx/dotenvx": "^1.25.1",
     "@iarna/toml": "^2.2.5",
-    "@types/shell-quote": "1.7.5",
-    "@types/tar": "6.1.13",
     "axios": "^1.6.1",
-    "dotenv": "16.5.0",
     "fast-glob": "^3.3.0",
     "form-data": "^4.0.0",
     "shell-quote": "^1.8.2",
     "tar": "^6.2.0",
-    "typedoc": "0.27.9",
-    "typedoc-plugin-markdown": "4.4.2",
-    "typedoc-plugin-merge-modules": "6.1.0",
     "untildify": "^5.0.0",
     "uuid": "^11.0.3"
-  },
-  "packageManager": "yarn@4.6.0",
-  "type": "commonjs"
-}
+  }
+}