@limrun/api 0.63.0 → 0.64.0

package/src/ios-client.ts

@@ -17,6 +17,7 @@ import { prepareAppBundlePath, watchAppArchive } from './app-archive';
 import { downloadFileToLocalPath } from './internal/download-file';
 import { sleep } from './internal/utils/sleep';
 import { nodeProxyTransport } from './internal/proxy-transport';
+import { postTrustedCaCertificate } from './internal/trusted-ca';
 import {
   getDestinationTunnelStatus,
   stopDestinationTunnel,
@@ -78,6 +79,12 @@ export type Tunnel = DestinationTcpTunnel;
 export type TunnelOptions = DestinationTunnelStartOptions;
 export type TunnelStatus = DestinationTunnelStatus;
 
+/** A CA certificate the simulator now trusts. */
+export type TrustedCaCertificate = {
+  /** SHA-256 of the certificate's DER encoding, in hex. */
+  sha256: string;
+};
+
 /**
  * Events emitted by a simctl execution
  */
@@ -183,12 +190,19 @@ export function parseElementTreeResultMessage(
 // Result Types
 // ============================================================================
 
+export type ScreenshotOptions = {
+  /** Image encoding. Defaults to jpeg. PNG screenshots have no alpha channel. */
+  format?: 'jpeg' | 'png';
+  /** scaled uses tap-point dimensions; full preserves native pixels. Defaults to scaled. */
+  size?: 'scaled' | 'full';
+};
+
 export type ScreenshotData = {
-  /** Base64-encoded JPEG image data */
+  /** Base64-encoded image data in the requested format. */
   base64: string;
-  /** Width in points (for tap coordinates) */
+  /** Width in points for scaled screenshots, or native pixels for full screenshots. */
   width: number;
-  /** Height in points (for tap coordinates) */
+  /** Height in points for scaled screenshots, or native pixels for full screenshots. */
   height: number;
 };
 
@@ -654,7 +668,7 @@ export type InstanceClient = {
    * Take a screenshot of the active screen
    * @returns A promise that resolves to the screenshot data with base64 image and dimensions
    */
-  screenshot: () => Promise<ScreenshotData>;
+  screenshot: (options?: ScreenshotOptions) => Promise<ScreenshotData>;
 
   /**
    * Get the element tree (accessibility hierarchy) of the current screen
@@ -840,7 +854,7 @@ export type InstanceClient = {
   /** Returns null for a simulator without a hinge. */
   getFoldState: () => Promise<FoldState | null>;
   /** Capture an upright Duo display. A powered-off display returns its native black image. */
-  screenshotDisplay: (display: 'outer' | 'inner') => Promise<ScreenshotData>;
+  screenshotDisplay: (display: 'outer' | 'inner', options?: ScreenshotOptions) => Promise<ScreenshotData>;
   /** Tap in point coordinates returned by screenshotDisplay. */
   tapDisplay: (display: 'outer' | 'inner', x: number, y: number) => Promise<void>;
   setDuoOrientation: (orientation: DuoOrientation) => Promise<FoldState>;
@@ -1020,6 +1034,14 @@ export type InstanceClient = {
    */
   setStoreKitConfig: (bundleId: string, storekit: Buffer | Uint8Array) => Promise<void>;
 
+  /**
+   * Trust a PEM-encoded CA certificate on the simulator, for example the CA of
+   * an intercepting proxy you record traffic with. Safari and apps trust it on
+   * their next connection. It lasts for the life of the instance, and adding a
+   * certificate the simulator already trusts changes nothing.
+   */
+  addCaCertificate: (pem: string) => Promise<TrustedCaCertificate>;
+
   /**
    * Clear the registered StoreKit configuration for `bundleId` and
    * remove the app's Octane file so subsequent StoreKit requests fall
@@ -2171,6 +2193,7 @@ export async function createInstanceClient(options: InstanceClientOptions): Prom
             keepAlive,
             syncApp,
             setStoreKitConfig,
+            addCaCertificate,
             clearStoreKitConfig,
             discoverStoreKitConfig,
             softReset,
@@ -2204,8 +2227,8 @@ export async function createInstanceClient(options: InstanceClientOptions): Prom
     // Client Methods - using centralized sendRequest
     // ========================================================================
 
-    const screenshot = (): Promise<ScreenshotData> => {
-      return sendRequest<ScreenshotData>('screenshot');
+    const screenshot = (options: ScreenshotOptions = {}): Promise<ScreenshotData> => {
+      return sendRequest<ScreenshotData>('screenshot', options);
     };
 
     const elementTree = (point?: AccessibilityPoint): Promise<ElementTree> => {
@@ -2518,8 +2541,10 @@ export async function createInstanceClient(options: InstanceClientOptions): Prom
         return Promise.reject(new RangeError('Invalid iPhone Duo orientation'));
       return sendRequest('setDuoOrientation', { orientation });
     };
-    const screenshotDisplay = (display: 'outer' | 'inner'): Promise<ScreenshotData> =>
-      sendRequest('screenshotDisplay', { display });
+    const screenshotDisplay = (
+      display: 'outer' | 'inner',
+      options?: ScreenshotOptions,
+    ): Promise<ScreenshotData> => sendRequest('screenshotDisplay', { display, ...options });
     const tapDisplay = (display: 'outer' | 'inner', x: number, y: number): Promise<void> =>
       sendRequest('tapDisplay', { display, x, y });
     const getFoldState = (): Promise<FoldState | null> => sendRequest('getFoldState');
@@ -2970,6 +2995,9 @@ export async function createInstanceClient(options: InstanceClientOptions): Prom
       }
     };
 
+    const addCaCertificate = (pem: string): Promise<TrustedCaCertificate> =>
+      postTrustedCaCertificate(`${options.apiUrl}/trusted-cas`, options.token, pem);
+
     const clearStoreKitConfig = async (bundleId: string): Promise<void> => {
       const url = `${options.apiUrl}/payments/storeKitConfigs/${encodeURIComponent(bundleId)}`;
       const response = await nodeProxyTransport.fetch(url, {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.63.0'; // x-release-please-version
+export const VERSION = '0.64.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.63.0";
+export declare const VERSION = "0.64.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.63.0'; // x-release-please-version
+exports.VERSION = '0.64.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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