@limrun/api 0.42.2 → 0.43.0

package/src/client.ts

@@ -73,6 +73,7 @@ import {
   XcodeClient,
   XcodeProjectConfig,
   XcodeBuildOptions,
+  XcodeRunOptions,
   ReactNativeBuildConfig,
   SimulatorAttachResult,
   SimulatorStatus,
@@ -891,6 +892,7 @@ export declare namespace Limrun {
     type XcodeClient as XcodeClient,
     type XcodeProjectConfig as XcodeProjectConfig,
     type XcodeBuildOptions as XcodeBuildOptions,
+    type XcodeRunOptions as XcodeRunOptions,
     type ReactNativeBuildConfig as ReactNativeBuildConfig,
     type SimulatorAttachResult as SimulatorAttachResult,
     type SimulatorStatus as SimulatorStatus,

package/src/exec-client.ts

@@ -12,7 +12,7 @@ import { nodeProxyTransport } from './internal/proxy-transport';
 // Types
 // =============================================================================
 
-export type ExecRequest = XcodeBuildExecRequest | GradleBuildExecRequest;
+export type ExecRequest = XcodeBuildExecRequest | GradleBuildExecRequest | RunExecRequest;
 
 export type XcodeBuildExecRequest = {
   command: 'xcodebuild';
@@ -81,6 +81,14 @@ export type GradleBuildExecRequest = {
   };
 };
 
+export type RunExecRequest = {
+  command: 'run';
+  commandLine: string;
+  cwd?: string;
+  env?: Record<string, string>;
+  timeoutSeconds?: number;
+};
+
 export type ExecOptions = {
   apiUrl: string;
   token: string;
@@ -250,7 +258,7 @@ export class ExecChildProcess implements PromiseLike<ExecResult> {
       this.sseConnection = null;
     }
     if (!this.execId) {
-      this.log('warn', 'Failed to cancel build: execId is not set');
+      this.log('warn', 'Failed to cancel execution: execId is not set');
       return;
     }
     try {
@@ -260,9 +268,9 @@ export class ExecChildProcess implements PromiseLike<ExecResult> {
           Authorization: `Bearer ${this.options.token}`,
         },
       });
-      this.log('info', 'Build cancelled');
+      this.log('info', 'Execution cancelled');
     } catch (err) {
-      this.log('warn', `Failed to cancel build: ${err}`);
+      this.log('warn', `Failed to cancel execution: ${err}`);
     }
   }
 
@@ -275,7 +283,11 @@ export class ExecChildProcess implements PromiseLike<ExecResult> {
     // spread into ExecResult below so callers can surface the download URL), so
     // it is stripped from the wire body: the daemon OpenAPI schemas do not
     // declare it, and sending it would 400 under strict request validation.
-    const { additionalMetadata: _clientOnly, ...wireRequest } = request;
+    // The 'run' command has no artifact upload and never carries it.
+    const wireRequest = { ...request };
+    if ('additionalMetadata' in wireRequest) {
+      delete wireRequest.additionalMetadata;
+    }
     let execRes: Response;
     try {
       execRes = await nodeProxyTransport.fetch(`${apiUrl}/exec`, {
@@ -315,7 +327,7 @@ export class ExecChildProcess implements PromiseLike<ExecResult> {
 
     const execData = (await execRes.json()) as { execId: string };
     this.execId = execData.execId;
-    log('debug', `Build started: ${this.execId}`);
+    log('debug', `Execution started: ${this.execId}`);
 
     // 2. Stream logs via SSE and wait for exit code
     const eventsUrl = `${apiUrl}/exec/${this.execId}/events`;
@@ -326,6 +338,8 @@ export class ExecChildProcess implements PromiseLike<ExecResult> {
     let timeoutMs = 3600 * 1000;
     if (request.command === 'xcodebuild' && request.testflight) {
       timeoutMs += (Math.max(0, request.testflight.waitTimeoutSeconds ?? 120) + 900) * 1000;
+    } else if (request.command === 'run') {
+      timeoutMs = (Math.max(1, request.timeoutSeconds ?? 3600) + 60) * 1000;
     }
     let exitCode: number;
     let timedOut = false;
@@ -339,7 +353,7 @@ export class ExecChildProcess implements PromiseLike<ExecResult> {
       ]);
     } catch {
       if (this.killed) {
-        log('debug', 'Build killed');
+        log('debug', 'Execution killed');
         exitCode = -1;
       } else {
         // The client stopped waiting; the remote build may still be running.
@@ -376,12 +390,12 @@ export class ExecChildProcess implements PromiseLike<ExecResult> {
       exitCode,
       execId: this.execId!,
       status,
-      ...(request.additionalMetadata ?? {}),
+      ...('additionalMetadata' in request ? request.additionalMetadata ?? {} : {}),
       ...(this.testflightEvent ? { testflight: this.testflightEvent } : {}),
       ...(timedOut ? { timedOut } : {}),
     };
 
-    this.log('debug', `Build finished: ${result.status} (exit ${result.exitCode})`);
+    this.log('debug', `Execution finished: ${result.status} (exit ${result.exitCode})`);
     return result;
   }
 
@@ -426,7 +440,7 @@ export class ExecChildProcess implements PromiseLike<ExecResult> {
                 this.log('warn', `SSE exitCode event has invalid data: ${data}`);
                 return;
               }
-              this.log('debug', `Build completed via SSE: exitCode=${exitCode}`);
+              this.log('debug', `Execution completed via SSE: exitCode=${exitCode}`);
               resolve(exitCode);
             }
           },

package/src/index.ts

@@ -41,6 +41,7 @@ export {
   DEFAULT_RBE_TUNNEL_PORT,
   type XcodeProjectConfig,
   type XcodeBuildOptions,
+  type XcodeRunOptions,
   type XcodeGenConfig,
   type ReactNativeBuildConfig,
   type SimulatorAttachResult,

package/src/resources/index.ts

@@ -53,6 +53,7 @@ export {
   type XcodeClient,
   type XcodeProjectConfig,
   type XcodeBuildOptions,
+  type XcodeRunOptions,
   type XcodeGenConfig,
   type ReactNativeBuildConfig,
   type SimulatorAttachResult,

package/src/resources/xcode-instances-helpers.ts

@@ -68,6 +68,14 @@ export type SyncOptions = {
   onSyncComplete?: FolderSyncOptions['onSyncComplete'];
 };
 
+export type XcodeRunOptions = {
+  /** Working directory relative to the synced workspace root. Defaults to ".". */
+  cwd?: string;
+  /** Environment variables to add to limbuild's curated sandbox environment. */
+  env?: Record<string, string>;
+  /** Server-side timeout in seconds. Defaults to 3600; maximum 21600. */
+  timeoutSeconds?: number;
+};
 export type XcodeProjectConfig = {
   workspace?: string;
   project?: string;
@@ -318,6 +326,12 @@ export type XcodeClient = {
    */
   xcodebuild: (settings?: XcodeProjectConfig, options?: XcodeBuildOptions) => ExecChildProcess;
 
+  /**
+   * Run a one-shot shell command in the synced workspace.
+   * Output and the remote exit code are streamed through the returned process.
+   */
+  run: (commandLine: string, options?: XcodeRunOptions) => ExecChildProcess;
+
   /**
    * Attach a simulator to this xcode instance.
    * After attaching, the latest installable build is installed on the simulator:
@@ -727,6 +741,28 @@ export class XcodeInstances extends GeneratedXcodeInstances {
         return exec(request, { apiUrl, token, log });
       },
 
+      run(commandLine: string, options?: XcodeRunOptions): ExecChildProcess {
+        if (commandLine.trim() === '') {
+          throw new Error('commandLine must not be empty');
+        }
+        if (
+          options?.timeoutSeconds !== undefined &&
+          (!Number.isInteger(options.timeoutSeconds) ||
+            options.timeoutSeconds < 1 ||
+            options.timeoutSeconds > 21600)
+        ) {
+          throw new Error('timeoutSeconds must be an integer between 1 and 21600');
+        }
+        const request: ExecRequest = {
+          command: 'run',
+          commandLine,
+          cwd: options?.cwd ?? '.',
+          ...(options?.env && { env: options.env }),
+          ...(options?.timeoutSeconds !== undefined && { timeoutSeconds: options.timeoutSeconds }),
+        };
+        return exec(request, { apiUrl, token, log });
+      },
+
       async getSimulator(): Promise<SimulatorStatus> {
         const res = await nodeProxyTransport.fetch(`${apiUrl}/simulator`, {
           method: 'GET',

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.42.2'; // x-release-please-version
+export const VERSION = '0.43.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.42.2";
+export declare const VERSION = "0.43.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.42.2";
+export declare const VERSION = "0.43.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.42.2'; // x-release-please-version
+exports.VERSION = '0.43.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.42.2'; // x-release-please-version
+export const VERSION = '0.43.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map