@limrun/api 0.16.0 → 0.17.0-rc.1

package/index.d.mts

@@ -4,5 +4,6 @@ export { APIPromise } from "./core/api-promise.mjs";
 export { Limrun, type ClientOptions } from "./client.mjs";
 export { PagePromise } from "./core/pagination.mjs";
 export * from "./instance-client.mjs";
+export * as Ios from "./ios-client.mjs";
 export { LimrunError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } from "./core/error.mjs";
 //# sourceMappingURL=index.d.mts.map

package/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"OAEO,EAAE,MAAM,IAAI,OAAO,EAAE;OAErB,EAAE,KAAK,UAAU,EAAE,MAAM,EAAE;OAC3B,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,KAAK,aAAa,EAAE;OAC9B,EAAE,WAAW,EAAE;;OAEf,EACL,WAAW,EACX,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"OAEO,EAAE,MAAM,IAAI,OAAO,EAAE;OAErB,EAAE,KAAK,UAAU,EAAE,MAAM,EAAE;OAC3B,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,KAAK,aAAa,EAAE;OAC9B,EAAE,WAAW,EAAE;;OAEf,KAAK,GAAG;OACR,EACL,WAAW,EACX,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB"}

package/index.d.ts

@@ -4,5 +4,6 @@ export { APIPromise } from "./core/api-promise.js";
 export { Limrun, type ClientOptions } from "./client.js";
 export { PagePromise } from "./core/pagination.js";
 export * from "./instance-client.js";
+export * as Ios from "./ios-client.js";
 export { LimrunError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } from "./core/error.js";
 //# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"OAEO,EAAE,MAAM,IAAI,OAAO,EAAE;OAErB,EAAE,KAAK,UAAU,EAAE,MAAM,EAAE;OAC3B,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,KAAK,aAAa,EAAE;OAC9B,EAAE,WAAW,EAAE;;OAEf,EACL,WAAW,EACX,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"OAEO,EAAE,MAAM,IAAI,OAAO,EAAE;OAErB,EAAE,KAAK,UAAU,EAAE,MAAM,EAAE;OAC3B,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,KAAK,aAAa,EAAE;OAC9B,EAAE,WAAW,EAAE;;OAEf,KAAK,GAAG;OACR,EACL,WAAW,EACX,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB"}

package/index.js

@@ -4,7 +4,7 @@ exports = module.exports = function (...args) {
   return new exports.default(...args)
 }
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UnprocessableEntityError = exports.PermissionDeniedError = exports.InternalServerError = exports.AuthenticationError = exports.BadRequestError = exports.RateLimitError = exports.ConflictError = exports.NotFoundError = exports.APIUserAbortError = exports.APIConnectionTimeoutError = exports.APIConnectionError = exports.APIError = exports.LimrunError = exports.PagePromise = exports.Limrun = exports.APIPromise = exports.toFile = exports.default = void 0;
+exports.UnprocessableEntityError = exports.PermissionDeniedError = exports.InternalServerError = exports.AuthenticationError = exports.BadRequestError = exports.RateLimitError = exports.ConflictError = exports.NotFoundError = exports.APIUserAbortError = exports.APIConnectionTimeoutError = exports.APIConnectionError = exports.APIError = exports.LimrunError = exports.Ios = exports.PagePromise = exports.Limrun = exports.APIPromise = exports.toFile = exports.default = void 0;
 const tslib_1 = require("./internal/tslib.js");
 var client_1 = require("./client.js");
 Object.defineProperty(exports, "default", { enumerable: true, get: function () { return client_1.Limrun; } });
@@ -17,6 +17,7 @@ Object.defineProperty(exports, "Limrun", { enumerable: true, get: function () {
 var pagination_1 = require("./core/pagination.js");
 Object.defineProperty(exports, "PagePromise", { enumerable: true, get: function () { return pagination_1.PagePromise; } });
 tslib_1.__exportStar(require("./instance-client.js"), exports);
+exports.Ios = tslib_1.__importStar(require("./ios-client.js"));
 var error_1 = require("./core/error.js");
 Object.defineProperty(exports, "LimrunError", { enumerable: true, get: function () { return error_1.LimrunError; } });
 Object.defineProperty(exports, "APIError", { enumerable: true, get: function () { return error_1.APIError; } });

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,sCAA6C;AAApC,iGAAA,MAAM,OAAW;AAE1B,6CAAyD;AAA/B,iGAAA,MAAM,OAAA;AAChC,qDAAgD;AAAvC,yGAAA,UAAU,OAAA;AACnB,sCAAsD;AAA7C,gGAAA,MAAM,OAAA;AACf,mDAAgD;AAAvC,yGAAA,WAAW,OAAA;AACpB,+DAAkC;AAClC,yCAcsB;AAbpB,oGAAA,WAAW,OAAA;AACX,iGAAA,QAAQ,OAAA;AACR,2GAAA,kBAAkB,OAAA;AAClB,kHAAA,yBAAyB,OAAA;AACzB,0GAAA,iBAAiB,OAAA;AACjB,sGAAA,aAAa,OAAA;AACb,sGAAA,aAAa,OAAA;AACb,uGAAA,cAAc,OAAA;AACd,wGAAA,eAAe,OAAA;AACf,4GAAA,mBAAmB,OAAA;AACnB,4GAAA,mBAAmB,OAAA;AACnB,8GAAA,qBAAqB,OAAA;AACrB,iHAAA,wBAAwB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,sCAA6C;AAApC,iGAAA,MAAM,OAAW;AAE1B,6CAAyD;AAA/B,iGAAA,MAAM,OAAA;AAChC,qDAAgD;AAAvC,yGAAA,UAAU,OAAA;AACnB,sCAAsD;AAA7C,gGAAA,MAAM,OAAA;AACf,mDAAgD;AAAvC,yGAAA,WAAW,OAAA;AACpB,+DAAkC;AAClC,+DAAoC;AACpC,yCAcsB;AAbpB,oGAAA,WAAW,OAAA;AACX,iGAAA,QAAQ,OAAA;AACR,2GAAA,kBAAkB,OAAA;AAClB,kHAAA,yBAAyB,OAAA;AACzB,0GAAA,iBAAiB,OAAA;AACjB,sGAAA,aAAa,OAAA;AACb,sGAAA,aAAa,OAAA;AACb,uGAAA,cAAc,OAAA;AACd,wGAAA,eAAe,OAAA;AACf,4GAAA,mBAAmB,OAAA;AACnB,4GAAA,mBAAmB,OAAA;AACnB,8GAAA,qBAAqB,OAAA;AACrB,iHAAA,wBAAwB,OAAA"}

package/index.mjs

@@ -5,5 +5,6 @@ export { APIPromise } from "./core/api-promise.mjs";
 export { Limrun } from "./client.mjs";
 export { PagePromise } from "./core/pagination.mjs";
 export * from "./instance-client.mjs";
+export * as Ios from "./ios-client.mjs";
 export { LimrunError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } from "./core/error.mjs";
 //# sourceMappingURL=index.mjs.map

package/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,MAAM,IAAI,OAAO,EAAE;OAErB,EAAmB,MAAM,EAAE;OAC3B,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAsB;OAC9B,EAAE,WAAW,EAAE;;OAEf,EACL,WAAW,EACX,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,MAAM,IAAI,OAAO,EAAE;OAErB,EAAmB,MAAM,EAAE;OAC3B,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAsB;OAC9B,EAAE,WAAW,EAAE;;OAEf,KAAK,GAAG;OACR,EACL,WAAW,EACX,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB"}

package/internal/tslib.js

@@ -5,6 +5,7 @@ exports.__classPrivateFieldSet = __classPrivateFieldSet;
 exports.__classPrivateFieldGet = __classPrivateFieldGet;
 exports.__importStar = __importStar;
 exports.__exportStar = __exportStar;
+exports.__importDefault = __importDefault;
 function __classPrivateFieldSet(receiver, state, value, kind, f) {
     if (kind === "m")
         throw new TypeError("Private method is not writable");
@@ -79,3 +80,6 @@ function __exportStar(m, o) {
         if (p !== "default" && !Object.prototype.hasOwnProperty.call(o, p))
             __createBinding(o, m, p);
 }
+function __importDefault(mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+}

package/ios-client.d.mts

@@ -0,0 +1,207 @@
+import { EventEmitter } from 'events';
+/**
+ * Connection state of the instance client
+ */
+export type ConnectionState = 'connecting' | 'connected' | 'disconnected' | 'reconnecting';
+/**
+ * Callback function for connection state changes
+ */
+export type ConnectionStateCallback = (state: ConnectionState) => void;
+/**
+ * Events emitted by a simctl execution
+ */
+export interface SimctlExecutionEvents {
+    stdout: (data: Buffer) => void;
+    stderr: (data: Buffer) => void;
+    'line-stdout': (line: string) => void;
+    'line-stderr': (line: string) => void;
+    exit: (code: number) => void;
+    error: (error: Error) => void;
+}
+/**
+ * A client for interacting with a Limrun iOS instance
+ */
+export type InstanceClient = {
+    /**
+     * Take a screenshot of the current screen
+     * @returns A promise that resolves to the screenshot data
+     */
+    screenshot: () => Promise<ScreenshotData>;
+    /**
+     * Disconnect from the Limrun instance
+     */
+    disconnect: () => void;
+    /**
+     * Get current connection state
+     */
+    getConnectionState: () => ConnectionState;
+    /**
+     * Register callback for connection state changes
+     * @returns A function to unregister the callback
+     */
+    onConnectionStateChange: (callback: ConnectionStateCallback) => () => void;
+    /**
+     * Run `simctl` command targeting the instance with given arguments.
+     * Returns an EventEmitter that streams stdout, stderr, and exit events.
+     *
+     * @param args Arguments to pass to simctl
+     * @returns A SimctlExecution handle for listening to command output
+     *
+     * @example
+     * ```typescript
+     * const execution = client.simctl(['boot', 'device-id']);
+     *
+     * // Listen to raw data
+     * execution.on('stdout', (data) => {
+     *   console.log('stdout:', data.toString());
+     * });
+     *
+     * // Or listen line-by-line
+     * execution.on('line-stdout', (line) => {
+     *   console.log('Line:', line);
+     * });
+     *
+     * execution.on('line-stderr', (line) => {
+     *   console.error('Error:', line);
+     * });
+     *
+     * execution.on('exit', (code) => {
+     *   console.log('Process exited with code:', code);
+     * });
+     *
+     * // Or wait for completion
+     * const result = await execution.wait();
+     * console.log('Exit code:', result.code);
+     * console.log('Full stdout:', result.stdout.toString());
+     * ```
+     */
+    simctl: (args: string[]) => SimctlExecution;
+    /**
+     * Copy a file to the sandbox of the simulator. Returns the path of the file that can be used in simctl commands.
+     * @param name The name of the file in the sandbox of the simulator.
+     * @param path The path of the file to copy to the sandbox of the simulator.
+     * @returns A promise that resolves to the path of the file that can be used in simctl commands.
+     */
+    cp: (name: string, path: string) => Promise<string>;
+};
+/**
+ * Controls the verbosity of logging in the client
+ */
+export type LogLevel = 'none' | 'error' | 'warn' | 'info' | 'debug';
+/**
+ * Configuration options for creating an iOS client
+ */
+export type InstanceClientOptions = {
+    /**
+     * The API URL for the instance.
+     */
+    apiUrl: string;
+    /**
+     * The token to use for authentication.
+     */
+    token: string;
+    /**
+     * Controls logging verbosity
+     * @default 'info'
+     */
+    logLevel?: LogLevel;
+    /**
+     * Maximum number of reconnection attempts
+     * @default 6
+     */
+    maxReconnectAttempts?: number;
+    /**
+     * Initial reconnection delay in milliseconds
+     * @default 1000
+     */
+    reconnectDelay?: number;
+    /**
+     * Maximum reconnection delay in milliseconds
+     * @default 30000
+     */
+    maxReconnectDelay?: number;
+};
+type ScreenshotData = {
+    dataUri: string;
+};
+/**
+ * Handle for a running simctl command execution.
+ *
+ * This class extends EventEmitter and provides streaming access to command output.
+ * Methods starting with underscore (_) are internal and should not be called directly.
+ *
+ * @example
+ * ```typescript
+ * const execution = client.simctl(['boot', 'device-id']);
+ *
+ * // Listen to raw output
+ * execution.on('stdout', (data) => console.log(data.toString()));
+ *
+ * // Or listen line-by-line (more convenient for most use cases)
+ * execution.on('line-stdout', (line) => console.log('Output:', line));
+ * execution.on('line-stderr', (line) => console.error('Error:', line));
+ *
+ * execution.on('exit', (code) => console.log('Exit code:', code));
+ * ```
+ */
+export declare class SimctlExecution extends EventEmitter {
+    private stdoutChunks;
+    private stderrChunks;
+    private stdoutLineBuffer;
+    private stderrLineBuffer;
+    private exitCodeValue;
+    private completed;
+    private waitPromise;
+    private stopCallback;
+    get isRunning(): boolean;
+    constructor(stopCallback: () => void);
+    /**
+     * Register an event listener for stdout, stderr, line-stdout, line-stderr, exit, or error events.
+     * @param event The event name
+     * @param listener The callback function for this event
+     */
+    on<E extends keyof SimctlExecutionEvents>(event: E, listener: SimctlExecutionEvents[E]): this;
+    /**
+     * Register a one-time event listener that will be removed after firing once.
+     * @param event The event name
+     * @param listener The callback function for this event
+     */
+    once<E extends keyof SimctlExecutionEvents>(event: E, listener: SimctlExecutionEvents[E]): this;
+    /**
+     * Remove an event listener.
+     * @param event The event name
+     * @param listener The callback function to remove
+     */
+    off<E extends keyof SimctlExecutionEvents>(event: E, listener: SimctlExecutionEvents[E]): this;
+    /**
+     * Wait for the command to complete and get the full result.
+     * This accumulates all stdout/stderr chunks in memory.
+     * @returns Promise that resolves with exit code and complete output
+     */
+    wait(): Promise<{
+        code: number;
+        stdout: Buffer;
+        stderr: Buffer;
+    }>;
+    /**
+     * Stop the running simctl command (if supported by server).
+     * This cleans up the execution tracking.
+     */
+    stop(): void;
+    /** @internal - Handle stdout data from server */
+    _handleStdout(data: Buffer): void;
+    /** @internal - Handle stderr data from server */
+    _handleStderr(data: Buffer): void;
+    /** @internal - Handle exit code from server */
+    _handleExit(code: number): void;
+    /** @internal - Handle errors from server or connection */
+    _handleError(error: Error): void;
+}
+/**
+ * Creates a client for interacting with a Limrun iOS instance
+ * @param options Configuration options including webrtcUrl, token and log level
+ * @returns An InstanceClient for controlling the instance
+ */
+export declare function createInstanceClient(options: InstanceClientOptions): Promise<InstanceClient>;
+export {};
+//# sourceMappingURL=ios-client.d.mts.map

package/ios-client.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ios-client.d.mts","sourceRoot":"","sources":["src/ios-client.ts"],"names":[],"mappings":"OAEO,EAAE,YAAY,EAAE,MAAM,QAAQ;AAErC;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,YAAY,GAAG,WAAW,GAAG,cAAc,GAAG,cAAc,CAAC;AAE3F;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/B,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/B,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7B,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;OAGG;IACH,UAAU,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,CAAC;IAE1C;;OAEG;IACH,UAAU,EAAE,MAAM,IAAI,CAAC;IAEvB;;OAEG;IACH,kBAAkB,EAAE,MAAM,eAAe,CAAC;IAE1C;;;OAGG;IACH,uBAAuB,EAAE,CAAC,QAAQ,EAAE,uBAAuB,KAAK,MAAM,IAAI,CAAC;IAE3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,eAAe,CAAC;IAE5C;;;;;OAKG;IACH,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CACrD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAaF,KAAK,cAAc,GAAG;IACpB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAmCF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,eAAgB,SAAQ,YAAY;IAC/C,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,gBAAgB,CAAM;IAC9B,OAAO,CAAC,gBAAgB,CAAM;IAC9B,OAAO,CAAC,aAAa,CAAuB;IAC5C,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,WAAW,CAA0E;IAC7F,OAAO,CAAC,YAAY,CAA6B;IAEjD,IAAW,SAAS,IAAI,OAAO,CAE9B;gBAEW,YAAY,EAAE,MAAM,IAAI;IAKpC;;;;OAIG;IACM,EAAE,CAAC,CAAC,SAAS,MAAM,qBAAqB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,IAAI;IAItG;;;;OAIG;IACM,IAAI,CAAC,CAAC,SAAS,MAAM,qBAAqB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,IAAI;IAIxG;;;;OAIG;IACM,GAAG,CAAC,CAAC,SAAS,MAAM,qBAAqB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,IAAI;IAIvG;;;;OAIG;IACH,IAAI,IAAI,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IA+BjE;;;OAGG;IACH,IAAI,IAAI,IAAI;IAMZ,iDAAiD;IACjD,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAgBjC,iDAAiD;IACjD,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAgBjC,+CAA+C;IAC/C,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAgB/B,0DAA0D;IAC1D,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;CAIjC;AAED;;;;GAIG;AACH,wBAAsB,oBAAoB,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,cAAc,CAAC,CA2alG"}

package/ios-client.d.ts

@@ -0,0 +1,207 @@
+import { EventEmitter } from 'events';
+/**
+ * Connection state of the instance client
+ */
+export type ConnectionState = 'connecting' | 'connected' | 'disconnected' | 'reconnecting';
+/**
+ * Callback function for connection state changes
+ */
+export type ConnectionStateCallback = (state: ConnectionState) => void;
+/**
+ * Events emitted by a simctl execution
+ */
+export interface SimctlExecutionEvents {
+    stdout: (data: Buffer) => void;
+    stderr: (data: Buffer) => void;
+    'line-stdout': (line: string) => void;
+    'line-stderr': (line: string) => void;
+    exit: (code: number) => void;
+    error: (error: Error) => void;
+}
+/**
+ * A client for interacting with a Limrun iOS instance
+ */
+export type InstanceClient = {
+    /**
+     * Take a screenshot of the current screen
+     * @returns A promise that resolves to the screenshot data
+     */
+    screenshot: () => Promise<ScreenshotData>;
+    /**
+     * Disconnect from the Limrun instance
+     */
+    disconnect: () => void;
+    /**
+     * Get current connection state
+     */
+    getConnectionState: () => ConnectionState;
+    /**
+     * Register callback for connection state changes
+     * @returns A function to unregister the callback
+     */
+    onConnectionStateChange: (callback: ConnectionStateCallback) => () => void;
+    /**
+     * Run `simctl` command targeting the instance with given arguments.
+     * Returns an EventEmitter that streams stdout, stderr, and exit events.
+     *
+     * @param args Arguments to pass to simctl
+     * @returns A SimctlExecution handle for listening to command output
+     *
+     * @example
+     * ```typescript
+     * const execution = client.simctl(['boot', 'device-id']);
+     *
+     * // Listen to raw data
+     * execution.on('stdout', (data) => {
+     *   console.log('stdout:', data.toString());
+     * });
+     *
+     * // Or listen line-by-line
+     * execution.on('line-stdout', (line) => {
+     *   console.log('Line:', line);
+     * });
+     *
+     * execution.on('line-stderr', (line) => {
+     *   console.error('Error:', line);
+     * });
+     *
+     * execution.on('exit', (code) => {
+     *   console.log('Process exited with code:', code);
+     * });
+     *
+     * // Or wait for completion
+     * const result = await execution.wait();
+     * console.log('Exit code:', result.code);
+     * console.log('Full stdout:', result.stdout.toString());
+     * ```
+     */
+    simctl: (args: string[]) => SimctlExecution;
+    /**
+     * Copy a file to the sandbox of the simulator. Returns the path of the file that can be used in simctl commands.
+     * @param name The name of the file in the sandbox of the simulator.
+     * @param path The path of the file to copy to the sandbox of the simulator.
+     * @returns A promise that resolves to the path of the file that can be used in simctl commands.
+     */
+    cp: (name: string, path: string) => Promise<string>;
+};
+/**
+ * Controls the verbosity of logging in the client
+ */
+export type LogLevel = 'none' | 'error' | 'warn' | 'info' | 'debug';
+/**
+ * Configuration options for creating an iOS client
+ */
+export type InstanceClientOptions = {
+    /**
+     * The API URL for the instance.
+     */
+    apiUrl: string;
+    /**
+     * The token to use for authentication.
+     */
+    token: string;
+    /**
+     * Controls logging verbosity
+     * @default 'info'
+     */
+    logLevel?: LogLevel;
+    /**
+     * Maximum number of reconnection attempts
+     * @default 6
+     */
+    maxReconnectAttempts?: number;
+    /**
+     * Initial reconnection delay in milliseconds
+     * @default 1000
+     */
+    reconnectDelay?: number;
+    /**
+     * Maximum reconnection delay in milliseconds
+     * @default 30000
+     */
+    maxReconnectDelay?: number;
+};
+type ScreenshotData = {
+    dataUri: string;
+};
+/**
+ * Handle for a running simctl command execution.
+ *
+ * This class extends EventEmitter and provides streaming access to command output.
+ * Methods starting with underscore (_) are internal and should not be called directly.
+ *
+ * @example
+ * ```typescript
+ * const execution = client.simctl(['boot', 'device-id']);
+ *
+ * // Listen to raw output
+ * execution.on('stdout', (data) => console.log(data.toString()));
+ *
+ * // Or listen line-by-line (more convenient for most use cases)
+ * execution.on('line-stdout', (line) => console.log('Output:', line));
+ * execution.on('line-stderr', (line) => console.error('Error:', line));
+ *
+ * execution.on('exit', (code) => console.log('Exit code:', code));
+ * ```
+ */
+export declare class SimctlExecution extends EventEmitter {
+    private stdoutChunks;
+    private stderrChunks;
+    private stdoutLineBuffer;
+    private stderrLineBuffer;
+    private exitCodeValue;
+    private completed;
+    private waitPromise;
+    private stopCallback;
+    get isRunning(): boolean;
+    constructor(stopCallback: () => void);
+    /**
+     * Register an event listener for stdout, stderr, line-stdout, line-stderr, exit, or error events.
+     * @param event The event name
+     * @param listener The callback function for this event
+     */
+    on<E extends keyof SimctlExecutionEvents>(event: E, listener: SimctlExecutionEvents[E]): this;
+    /**
+     * Register a one-time event listener that will be removed after firing once.
+     * @param event The event name
+     * @param listener The callback function for this event
+     */
+    once<E extends keyof SimctlExecutionEvents>(event: E, listener: SimctlExecutionEvents[E]): this;
+    /**
+     * Remove an event listener.
+     * @param event The event name
+     * @param listener The callback function to remove
+     */
+    off<E extends keyof SimctlExecutionEvents>(event: E, listener: SimctlExecutionEvents[E]): this;
+    /**
+     * Wait for the command to complete and get the full result.
+     * This accumulates all stdout/stderr chunks in memory.
+     * @returns Promise that resolves with exit code and complete output
+     */
+    wait(): Promise<{
+        code: number;
+        stdout: Buffer;
+        stderr: Buffer;
+    }>;
+    /**
+     * Stop the running simctl command (if supported by server).
+     * This cleans up the execution tracking.
+     */
+    stop(): void;
+    /** @internal - Handle stdout data from server */
+    _handleStdout(data: Buffer): void;
+    /** @internal - Handle stderr data from server */
+    _handleStderr(data: Buffer): void;
+    /** @internal - Handle exit code from server */
+    _handleExit(code: number): void;
+    /** @internal - Handle errors from server or connection */
+    _handleError(error: Error): void;
+}
+/**
+ * Creates a client for interacting with a Limrun iOS instance
+ * @param options Configuration options including webrtcUrl, token and log level
+ * @returns An InstanceClient for controlling the instance
+ */
+export declare function createInstanceClient(options: InstanceClientOptions): Promise<InstanceClient>;
+export {};
+//# sourceMappingURL=ios-client.d.ts.map

package/ios-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ios-client.d.ts","sourceRoot":"","sources":["src/ios-client.ts"],"names":[],"mappings":"OAEO,EAAE,YAAY,EAAE,MAAM,QAAQ;AAErC;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,YAAY,GAAG,WAAW,GAAG,cAAc,GAAG,cAAc,CAAC;AAE3F;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/B,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/B,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7B,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;OAGG;IACH,UAAU,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,CAAC;IAE1C;;OAEG;IACH,UAAU,EAAE,MAAM,IAAI,CAAC;IAEvB;;OAEG;IACH,kBAAkB,EAAE,MAAM,eAAe,CAAC;IAE1C;;;OAGG;IACH,uBAAuB,EAAE,CAAC,QAAQ,EAAE,uBAAuB,KAAK,MAAM,IAAI,CAAC;IAE3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,eAAe,CAAC;IAE5C;;;;;OAKG;IACH,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CACrD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAaF,KAAK,cAAc,GAAG;IACpB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAmCF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,eAAgB,SAAQ,YAAY;IAC/C,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,gBAAgB,CAAM;IAC9B,OAAO,CAAC,gBAAgB,CAAM;IAC9B,OAAO,CAAC,aAAa,CAAuB;IAC5C,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,WAAW,CAA0E;IAC7F,OAAO,CAAC,YAAY,CAA6B;IAEjD,IAAW,SAAS,IAAI,OAAO,CAE9B;gBAEW,YAAY,EAAE,MAAM,IAAI;IAKpC;;;;OAIG;IACM,EAAE,CAAC,CAAC,SAAS,MAAM,qBAAqB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,IAAI;IAItG;;;;OAIG;IACM,IAAI,CAAC,CAAC,SAAS,MAAM,qBAAqB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,IAAI;IAIxG;;;;OAIG;IACM,GAAG,CAAC,CAAC,SAAS,MAAM,qBAAqB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,IAAI;IAIvG;;;;OAIG;IACH,IAAI,IAAI,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IA+BjE;;;OAGG;IACH,IAAI,IAAI,IAAI;IAMZ,iDAAiD;IACjD,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAgBjC,iDAAiD;IACjD,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAgBjC,+CAA+C;IAC/C,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAgB/B,0DAA0D;IAC1D,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;CAIjC;AAED;;;;GAIG;AACH,wBAAsB,oBAAoB,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,cAAc,CAAC,CA2alG"}