@magpiecloud/mags 1.8.16 → 1.9.0

package/nodejs/index.js

@@ -0,0 +1,602 @@
+/**
+ * Mags SDK - Execute scripts on Magpie's instant VM infrastructure
+ * @module @magpiecloud/mags
+ */
+
+const https = require('https');
+const http = require('http');
+const { URL } = require('url');
+
+class MagsError extends Error {
+  constructor(message, statusCode) {
+    super(message);
+    this.name = 'MagsError';
+    this.statusCode = statusCode || null;
+  }
+}
+
+class Mags {
+  /**
+   * Create a Mags client
+   * @param {object} options - Configuration options
+   * @param {string} options.apiUrl - API endpoint (default: https://api.magpiecloud.com)
+   * @param {string} options.apiToken - API token (required, or set MAGS_API_TOKEN env var)
+   * @param {number} options.timeout - Default request timeout in ms (default: 30000)
+   */
+  constructor(options = {}) {
+    this.apiUrl = (options.apiUrl || process.env.MAGS_API_URL || 'https://api.magpiecloud.com').replace(/\/+$/, '');
+    this.apiToken = options.apiToken || process.env.MAGS_API_TOKEN || process.env.MAGS_TOKEN;
+    this.timeout = options.timeout || 30000;
+
+    if (!this.apiToken) {
+      throw new MagsError('API token required. Set MAGS_API_TOKEN or pass apiToken option.');
+    }
+  }
+
+  _request(method, path, body = null, params = null) {
+    return new Promise((resolve, reject) => {
+      const url = new URL(path, this.apiUrl);
+      if (params) {
+        for (const [k, v] of Object.entries(params)) {
+          url.searchParams.set(k, v);
+        }
+      }
+      const isHttps = url.protocol === 'https:';
+      const lib = isHttps ? https : http;
+
+      const options = {
+        hostname: url.hostname,
+        port: url.port || (isHttps ? 443 : 80),
+        path: url.pathname + url.search,
+        method,
+        headers: {
+          'Authorization': `Bearer ${this.apiToken}`,
+          'Content-Type': 'application/json'
+        },
+        timeout: this.timeout
+      };
+
+      const req = lib.request(options, (res) => {
+        let data = '';
+        res.on('data', chunk => data += chunk);
+        res.on('end', () => {
+          try {
+            const parsed = JSON.parse(data);
+            if (res.statusCode >= 400) {
+              reject(new MagsError(parsed.error || parsed.message || `HTTP ${res.statusCode}`, res.statusCode));
+            } else {
+              resolve(parsed);
+            }
+          } catch {
+            if (res.statusCode >= 400) {
+              reject(new MagsError(data || `HTTP ${res.statusCode}`, res.statusCode));
+            } else {
+              resolve(data);
+            }
+          }
+        });
+      });
+
+      req.on('error', reject);
+      req.on('timeout', () => {
+        req.destroy();
+        reject(new MagsError('Request timed out'));
+      });
+      if (body) req.write(JSON.stringify(body));
+      req.end();
+    });
+  }
+
+  // ── Jobs ──────────────────────────────────────────────────────────
+
+  /**
+   * Submit a job for execution
+   * @param {string} script - Script to execute
+   * @param {object} options - Job options
+   * @param {string} options.name - Job name
+   * @param {string} options.workspaceId - Persistent workspace ID
+   * @param {string} options.baseWorkspaceId - Read-only base workspace to mount
+   * @param {boolean} options.persistent - Keep VM alive after script
+   * @param {boolean} options.noSleep - Never auto-sleep (requires persistent)
+   * @param {boolean} options.ephemeral - No workspace/S3 sync (fastest)
+   * @param {string} options.startupCommand - Command to run when waking from sleep
+   * @param {object} options.environment - Environment variables
+   * @param {string[]} options.fileIds - File IDs from uploadFiles()
+   * @param {number} options.diskGb - Custom disk size in GB (default 2)
+   * @param {string} options.rootfsType - VM rootfs type: standard, claude, pi
+   * @returns {Promise<{request_id: string, status: string}>}
+   */
+  async run(script, options = {}) {
+    if (options.ephemeral && options.workspaceId) {
+      throw new MagsError('Cannot use ephemeral with workspaceId');
+    }
+    if (options.ephemeral && options.persistent) {
+      throw new MagsError('Cannot use ephemeral with persistent');
+    }
+    if (options.noSleep && !options.persistent) {
+      throw new MagsError('noSleep requires persistent=true');
+    }
+
+    const payload = {
+      script,
+      type: 'inline',
+      persistent: options.persistent || false,
+    };
+
+    if (options.noSleep) payload.no_sleep = true;
+    if (options.name) payload.name = options.name;
+    if (!options.ephemeral && options.workspaceId) payload.workspace_id = options.workspaceId;
+    if (options.baseWorkspaceId) payload.base_workspace_id = options.baseWorkspaceId;
+    if (options.startupCommand) payload.startup_command = options.startupCommand;
+    if (options.environment) payload.environment = options.environment;
+    if (options.fileIds && options.fileIds.length > 0) payload.file_ids = options.fileIds;
+    if (options.diskGb) payload.disk_gb = options.diskGb;
+    if (options.rootfsType) payload.rootfs_type = options.rootfsType;
+
+    return this._request('POST', '/api/v1/mags-jobs', payload);
+  }
+
+  /**
+   * Run a job and wait for completion
+   * @param {string} script - Script to execute
+   * @param {object} options - Job options (same as run() plus timeout/pollInterval)
+   * @param {number} options.timeout - Timeout in ms (default: 60000)
+   * @param {number} options.pollInterval - Poll interval in ms (default: 1000)
+   * @returns {Promise<{requestId: string, status: string, exitCode: number, durationMs: number, logs: Array}>}
+   */
+  async runAndWait(script, options = {}) {
+    const timeout = options.timeout || 60000;
+    const pollInterval = options.pollInterval || 1000;
+    const result = await this.run(script, options);
+    const requestId = result.request_id;
+
+    const startTime = Date.now();
+    while (Date.now() - startTime < timeout) {
+      const status = await this.status(requestId);
+
+      if (status.status === 'completed' || status.status === 'error') {
+        const logsResp = await this.logs(requestId);
+        return {
+          requestId,
+          status: status.status,
+          exitCode: status.exit_code,
+          durationMs: status.script_duration_ms,
+          logs: logsResp.logs || []
+        };
+      }
+
+      await new Promise(resolve => setTimeout(resolve, pollInterval));
+    }
+
+    throw new MagsError(`Job ${requestId} timed out after ${timeout}ms`);
+  }
+
+  /**
+   * Get job status
+   * @param {string} requestId - Job request ID
+   * @returns {Promise<object>}
+   */
+  async status(requestId) {
+    return this._request('GET', `/api/v1/mags-jobs/${requestId}/status`);
+  }
+
+  /**
+   * Get job logs
+   * @param {string} requestId - Job request ID
+   * @returns {Promise<{logs: Array}>}
+   */
+  async logs(requestId) {
+    return this._request('GET', `/api/v1/mags-jobs/${requestId}/logs`);
+  }
+
+  /**
+   * List recent jobs
+   * @param {object} options - Pagination options
+   * @param {number} options.page - Page number (default: 1)
+   * @param {number} options.pageSize - Page size (default: 20)
+   * @returns {Promise<{jobs: Array, total: number}>}
+   */
+  async list(options = {}) {
+    const page = options.page || 1;
+    const pageSize = options.pageSize || 20;
+    return this._request('GET', `/api/v1/mags-jobs`, null, { page, page_size: pageSize });
+  }
+
+  /**
+   * Update a job's settings
+   * @param {string} requestId - Job request ID
+   * @param {object} options - Settings to update
+   * @param {string} options.startupCommand - Command to run when VM wakes from sleep
+   * @param {boolean} options.noSleep - If true, VM never auto-sleeps. If false, re-enables auto-sleep.
+   * @returns {Promise<object>}
+   */
+  async updateJob(requestId, options = {}) {
+    const payload = {};
+    if (options.startupCommand !== undefined) payload.startup_command = options.startupCommand;
+    if (options.noSleep !== undefined) payload.no_sleep = options.noSleep;
+    return this._request('PATCH', `/api/v1/mags-jobs/${requestId}`, payload);
+  }
+
+  /**
+   * Enable URL or SSH access for a job
+   * @param {string} requestId - Job request ID
+   * @param {number} port - Port to expose (default: 8080, use 22 for SSH)
+   * @returns {Promise<object>}
+   */
+  async enableAccess(requestId, port = 8080) {
+    return this._request('POST', `/api/v1/mags-jobs/${requestId}/access`, { port });
+  }
+
+  /**
+   * Enable public URL access for a job's VM
+   * @param {string} nameOrId - Job name, workspace ID, or request ID
+   * @param {number} port - Port to expose (default: 8080)
+   * @returns {Promise<object>} Object with url and access details
+   */
+  async url(nameOrId, port = 8080) {
+    const requestId = await this._resolveJobId(nameOrId);
+    const st = await this.status(requestId);
+    const resp = await this.enableAccess(requestId, port);
+    const subdomain = st.subdomain || resp.subdomain;
+    if (subdomain) {
+      resp.url = `https://${subdomain}.apps.magpiecloud.com`;
+    }
+    return resp;
+  }
+
+  /**
+   * Stop a running job. Accepts a job ID, job name, or workspace ID.
+   * @param {string} nameOrId - Job name, workspace ID, or request ID
+   * @returns {Promise<object>}
+   */
+  async stop(nameOrId) {
+    const requestId = await this._resolveJobId(nameOrId);
+    return this._request('POST', `/api/v1/mags-jobs/${requestId}/stop`);
+  }
+
+  /**
+   * Sync a running job's workspace to S3 without stopping the VM
+   * @param {string} requestId - Job request ID
+   * @returns {Promise<object>}
+   */
+  async sync(requestId) {
+    return this._request('POST', `/api/v1/mags-jobs/${requestId}/sync`);
+  }
+
+  /**
+   * Create a new VM sandbox and wait until it's running.
+   * By default, data lives on local disk only (no S3 sync).
+   * Pass persistent: true to enable S3 data persistence.
+   * @param {string} name - Workspace name
+   * @param {object} options - Options
+   * @param {boolean} options.persistent - Enable S3 data persistence (default: false)
+   * @param {string} options.baseWorkspaceId - Read-only base workspace to mount
+   * @param {number} options.diskGb - Custom disk size in GB
+   * @param {number} options.timeout - Timeout in ms (default: 30000)
+   * @param {number} options.pollInterval - Poll interval in ms (default: 1000)
+   * @returns {Promise<{request_id: string, status: string}>}
+   */
+  async new(name, options = {}) {
+    const timeout = options.timeout || 30000;
+    const pollInterval = options.pollInterval || 1000;
+
+    const result = await this.run('sleep infinity', {
+      workspaceId: name,
+      persistent: true,
+      baseWorkspaceId: options.baseWorkspaceId,
+      diskGb: options.diskGb,
+      rootfsType: options.rootfsType,
+    });
+    const requestId = result.request_id;
+
+    const startTime = Date.now();
+    while (Date.now() - startTime < timeout) {
+      const st = await this.status(requestId);
+      if (st.status === 'running' && st.vm_id) {
+        return { request_id: requestId, status: 'running' };
+      }
+      if (st.status === 'completed' || st.status === 'error') {
+        throw new MagsError(`Job ${requestId} ended unexpectedly: ${st.status}`);
+      }
+      await new Promise(resolve => setTimeout(resolve, pollInterval));
+    }
+
+    throw new MagsError(`Job ${requestId} did not start within ${timeout}ms`);
+  }
+
+  /**
+   * Find a running or sleeping job by name, workspace ID, or job ID
+   * @param {string} nameOrId - Job name, workspace ID, or request ID
+   * @returns {Promise<object|null>} The job object, or null if not found
+   */
+  async findJob(nameOrId) {
+    const resp = await this.list({ pageSize: 50 });
+    const jobs = resp.jobs || [];
+
+    // Priority 1: exact name match, running/sleeping
+    for (const j of jobs) {
+      if (j.name === nameOrId && (j.status === 'running' || j.status === 'sleeping')) return j;
+    }
+    // Priority 2: workspace_id match, running/sleeping
+    for (const j of jobs) {
+      if (j.workspace_id === nameOrId && (j.status === 'running' || j.status === 'sleeping')) return j;
+    }
+    // Priority 3: exact name match, any status
+    for (const j of jobs) {
+      if (j.name === nameOrId) return j;
+    }
+    // Priority 4: workspace_id match, any status
+    for (const j of jobs) {
+      if (j.workspace_id === nameOrId) return j;
+    }
+
+    return null;
+  }
+
+  /**
+   * Execute a command on an existing running/sleeping VM via HTTP exec endpoint
+   * @param {string} nameOrId - Job name, workspace ID, or request ID
+   * @param {string} command - Command to execute
+   * @param {object} options - Options
+   * @param {number} options.timeout - Timeout in ms (default: 30000)
+   * @returns {Promise<{exitCode: number, output: string, stderr: string}>}
+   */
+  async exec(nameOrId, command, options = {}) {
+    const timeout = options.timeout || 30000;
+
+    const job = await this.findJob(nameOrId);
+    if (!job) throw new MagsError(`No running or sleeping VM found for '${nameOrId}'`);
+    if (job.status !== 'running' && job.status !== 'sleeping') {
+      throw new MagsError(`VM for '${nameOrId}' is ${job.status}, needs to be running or sleeping`);
+    }
+
+    const requestId = job.request_id || job.id;
+    const resp = await this._request('POST', `/api/v1/mags-jobs/${requestId}/exec`, {
+      command,
+      timeout: Math.ceil(timeout / 1000),
+    });
+
+    return { exitCode: resp.exit_code, output: resp.stdout, stderr: resp.stderr };
+  }
+
+  /**
+   * Resize a workspace's disk. Stops the existing VM, then creates a new one.
+   * @param {string} workspace - Workspace name
+   * @param {number} diskGb - New disk size in GB
+   * @param {object} options - Options
+   * @param {number} options.timeout - Timeout in ms (default: 30000)
+   * @param {number} options.pollInterval - Poll interval in ms (default: 1000)
+   * @returns {Promise<{request_id: string, status: string}>}
+   */
+  async resize(workspace, diskGb, options = {}) {
+    const existing = await this.findJob(workspace);
+    if (existing && existing.status === 'running') {
+      await this._request('POST', `/api/v1/mags-jobs/${existing.request_id}/sync`);
+      await this._request('POST', `/api/v1/mags-jobs/${existing.request_id}/stop`);
+      await new Promise(resolve => setTimeout(resolve, 1000));
+    } else if (existing && existing.status === 'sleeping') {
+      await this._request('POST', `/api/v1/mags-jobs/${existing.request_id}/stop`);
+      await new Promise(resolve => setTimeout(resolve, 1000));
+    }
+
+    return this.new(workspace, { persistent: true, diskGb, timeout: options.timeout, pollInterval: options.pollInterval });
+  }
+
+  /**
+   * Get aggregated usage summary
+   * @param {object} options - Options
+   * @param {number} options.windowDays - Time window in days (default: 30)
+   * @returns {Promise<object>}
+   */
+  async usage(options = {}) {
+    return this._request('GET', '/api/v1/mags-jobs/usage', null, { window_days: options.windowDays || 30 });
+  }
+
+  // ── Workspaces ────────────────────────────────────────────────────
+
+  /**
+   * List all workspaces
+   * @returns {Promise<{workspaces: Array, total: number}>}
+   */
+  async listWorkspaces() {
+    return this._request('GET', '/api/v1/mags-workspaces');
+  }
+
+  /**
+   * Delete a workspace and all its stored data
+   * @param {string} workspaceId - Workspace ID to delete
+   * @returns {Promise<object>}
+   */
+  async deleteWorkspace(workspaceId) {
+    return this._request('DELETE', `/api/v1/mags-workspaces/${workspaceId}`);
+  }
+
+  // ── File uploads ──────────────────────────────────────────────────
+
+  /**
+   * Upload files for use in a job
+   * @param {string[]} filePaths - Array of local file paths
+   * @returns {Promise<string[]>} Array of file IDs
+   */
+  async uploadFiles(filePaths) {
+    const fs = require('fs');
+    const path = require('path');
+    const fileIds = [];
+
+    for (const filePath of filePaths) {
+      const fileName = path.basename(filePath);
+      const fileData = fs.readFileSync(filePath);
+      const boundary = '----MagsBoundary' + Date.now().toString(16);
+
+      const parts = [];
+      parts.push(`--${boundary}\r\n`);
+      parts.push(`Content-Disposition: form-data; name="file"; filename="${fileName}"\r\n`);
+      parts.push(`Content-Type: application/octet-stream\r\n\r\n`);
+      const header = Buffer.from(parts.join(''));
+      const footer = Buffer.from(`\r\n--${boundary}--\r\n`);
+      const body = Buffer.concat([header, fileData, footer]);
+
+      const response = await this._multipartRequest('/api/v1/mags-files', body, boundary);
+      if (response.file_id) {
+        fileIds.push(response.file_id);
+      } else {
+        throw new MagsError(`Failed to upload file: ${fileName}`);
+      }
+    }
+
+    return fileIds;
+  }
+
+  _multipartRequest(apiPath, body, boundary) {
+    return new Promise((resolve, reject) => {
+      const url = new URL(apiPath, this.apiUrl);
+      const isHttps = url.protocol === 'https:';
+      const lib = isHttps ? https : http;
+
+      const options = {
+        hostname: url.hostname,
+        port: url.port || (isHttps ? 443 : 80),
+        path: url.pathname,
+        method: 'POST',
+        headers: {
+          'Authorization': `Bearer ${this.apiToken}`,
+          'Content-Type': `multipart/form-data; boundary=${boundary}`,
+          'Content-Length': body.length
+        }
+      };
+
+      const req = lib.request(options, (res) => {
+        let data = '';
+        res.on('data', chunk => data += chunk);
+        res.on('end', () => {
+          try {
+            resolve(JSON.parse(data));
+          } catch {
+            resolve(data);
+          }
+        });
+      });
+
+      req.on('error', reject);
+      req.write(body);
+      req.end();
+    });
+  }
+
+  // ── Cron jobs ─────────────────────────────────────────────────────
+
+  /**
+   * Create a cron job
+   * @param {object} options - Cron job options
+   * @param {string} options.name - Cron job name
+   * @param {string} options.cronExpression - Cron expression (e.g., "0 * * * *")
+   * @param {string} options.script - Script to execute
+   * @param {string} options.workspaceId - Workspace ID
+   * @param {object} options.environment - Environment variables
+   * @param {boolean} options.persistent - Keep VM alive
+   * @returns {Promise<object>}
+   */
+  async cronCreate(options) {
+    const payload = {
+      name: options.name,
+      cron_expression: options.cronExpression,
+      script: options.script,
+      persistent: options.persistent || false
+    };
+    if (options.workspaceId) payload.workspace_id = options.workspaceId;
+    if (options.environment) payload.environment = options.environment;
+    return this._request('POST', '/api/v1/mags-cron', payload);
+  }
+
+  /**
+   * List cron jobs
+   * @returns {Promise<{cron_jobs: Array}>}
+   */
+  async cronList() {
+    return this._request('GET', '/api/v1/mags-cron');
+  }
+
+  /**
+   * Get a cron job
+   * @param {string} id - Cron job ID
+   * @returns {Promise<object>}
+   */
+  async cronGet(id) {
+    return this._request('GET', `/api/v1/mags-cron/${id}`);
+  }
+
+  /**
+   * Update a cron job
+   * @param {string} id - Cron job ID
+   * @param {object} updates - Fields to update
+   * @returns {Promise<object>}
+   */
+  async cronUpdate(id, updates) {
+    return this._request('PATCH', `/api/v1/mags-cron/${id}`, updates);
+  }
+
+  /**
+   * Delete a cron job
+   * @param {string} id - Cron job ID
+   * @returns {Promise<object>}
+   */
+  async cronDelete(id) {
+    return this._request('DELETE', `/api/v1/mags-cron/${id}`);
+  }
+
+  // ── URL aliases ───────────────────────────────────────────────────
+
+  /**
+   * Create a stable URL alias for a workspace
+   * @param {string} subdomain - Subdomain for the alias
+   * @param {string} workspaceId - Workspace to point to
+   * @param {string} domain - Domain (default: apps.magpiecloud.com)
+   * @returns {Promise<{id: string, subdomain: string, url: string}>}
+   */
+  async urlAliasCreate(subdomain, workspaceId, domain = 'apps.magpiecloud.com') {
+    return this._request('POST', '/api/v1/mags-url-aliases', {
+      subdomain,
+      workspace_id: workspaceId,
+      domain,
+    });
+  }
+
+  /**
+   * List all URL aliases
+   * @returns {Promise<{aliases: Array, total: number}>}
+   */
+  async urlAliasList() {
+    return this._request('GET', '/api/v1/mags-url-aliases');
+  }
+
+  /**
+   * Delete a URL alias by subdomain
+   * @param {string} subdomain - Subdomain to delete
+   * @returns {Promise<object>}
+   */
+  async urlAliasDelete(subdomain) {
+    return this._request('DELETE', `/api/v1/mags-url-aliases/${subdomain}`);
+  }
+
+  // ── Internal helpers ──────────────────────────────────────────────
+
+  /**
+   * Resolve a job name, workspace ID, or UUID to a request_id
+   * @param {string} nameOrId - Name, workspace ID, or request ID
+   * @returns {Promise<string>} The resolved request_id
+   */
+  async _resolveJobId(nameOrId) {
+    // If it looks like a UUID, use directly
+    if (nameOrId.length >= 32 && nameOrId.includes('-')) {
+      return nameOrId;
+    }
+    const job = await this.findJob(nameOrId);
+    if (!job) throw new MagsError(`No job found for '${nameOrId}'`);
+    return job.request_id || job.id;
+  }
+}
+
+module.exports = Mags;
+module.exports.Mags = Mags;
+module.exports.MagsError = MagsError;
+module.exports.default = Mags;

package/nodejs/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@magpiecloud/mags",
+  "version": "1.8.16",
+  "description": "Mags CLI & SDK - Execute commands and scripts on Mags Sandboxes",
+  "main": "index.js",
+  "bin": {
+    "mags": "./bin/mags.js"
+  },
+  "scripts": {
+    "test": "node bin/mags.js --help"
+  },
+  "keywords": [
+    "magpie",
+    "mags",
+    "vm",
+    "microvm",
+    "cloud",
+    "serverless",
+    "execution",
+    "cli",
+    "claude",
+    "claude-code"
+  ],
+  "author": "Magpie Cloud",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/magpiecloud/mags"
+  },
+  "homepage": "https://mags.run",
+  "bugs": {
+    "url": "https://github.com/magpiecloud/mags/issues"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "dependencies": {
+    "ws": "^8.18.0"
+  },
+  "files": [
+    "index.js",
+    "bin/mags.js",
+    "README.md"
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magpiecloud/mags",
-  "version": "1.8.16",
+  "version": "1.9.0",
   "description": "Mags CLI & SDK - Execute commands and scripts on Mags Sandboxes",
   "main": "index.js",
   "bin": {
@@ -16,30 +16,15 @@
     "microvm",
     "cloud",
     "serverless",
-    "execution",
-    "cli",
-    "claude",
-    "claude-code"
+    "execution"
   ],
   "author": "Magpie Cloud",
   "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/magpiecloud/mags"
-  },
   "homepage": "https://mags.run",
-  "bugs": {
-    "url": "https://github.com/magpiecloud/mags/issues"
-  },
   "engines": {
     "node": ">=14.0.0"
   },
   "dependencies": {
     "ws": "^8.18.0"
-  },
-  "files": [
-    "index.js",
-    "bin/mags.js",
-    "README.md"
-  ]
+  }
 }