appium-safari-driver 4.0.1 → 4.1.0

package/.github/workflows/publish.js.yml

@@ -5,6 +5,12 @@ on:
   push:
     branches: [ master ]
 
+permissions:
+  contents: write
+  pull-requests: write
+  issues: write
+  id-token: write # to enable use of OIDC for trusted publishing and npm provenance
+
 jobs:
   build:
     runs-on: macos-latest
@@ -30,6 +36,4 @@ jobs:
     - run: npx semantic-release
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
       name: Release
-

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [4.1.0](https://github.com/appium/appium-safari-driver/compare/v4.0.2...v4.1.0) (2025-11-25)
+
+### Features
+
+* Migrate driver sources to typescript ([#148](https://github.com/appium/appium-safari-driver/issues/148)) ([c851874](https://github.com/appium/appium-safari-driver/commit/c8518746317289f5db9b27c30639a8b8b42778ae))
+
+## [4.0.2](https://github.com/appium/appium-safari-driver/compare/v4.0.1...v4.0.2) (2025-11-15)
+
+### Miscellaneous Chores
+
+* publish via trusted publisher ([#146](https://github.com/appium/appium-safari-driver/issues/146)) ([385a2ad](https://github.com/appium/appium-safari-driver/commit/385a2ad42d9fbd05b9427145b787da0f95c550a6))
+
 ## [4.0.1](https://github.com/appium/appium-safari-driver/compare/v4.0.0...v4.0.1) (2025-08-23)
 
 ### Miscellaneous Chores

package/build/lib/commands/cookies.d.ts

@@ -1,7 +1,8 @@
+import type { SafariDriver } from '../driver';
 /**
- * @this {SafariDriver}
- * @returns {Promise<any>}
+ * Delete all cookies visible to the current page.
+ *
+ * @returns Promise that resolves when cookies are deleted
  */
-export function deleteCookies(this: import("../driver").SafariDriver): Promise<any>;
-export type SafariDriver = import("../driver").SafariDriver;
+export declare function deleteCookies(this: SafariDriver): Promise<any>;
 //# sourceMappingURL=cookies.d.ts.map

package/build/lib/commands/cookies.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cookies.d.ts","sourceRoot":"","sources":["../../../lib/commands/cookies.js"],"names":[],"mappings":"AACA;;;GAGG;AACH,uEAFa,OAAO,CAAC,GAAG,CAAC,CAIxB;2BAGY,OAAO,WAAW,EAAE,YAAY"}
+{"version":3,"file":"cookies.d.ts","sourceRoot":"","sources":["../../../lib/commands/cookies.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAE9C;;;;GAIG;AACH,wBAAsB,aAAa,CAAE,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,CAErE"}

package/build/lib/commands/cookies.js

@@ -2,13 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deleteCookies = deleteCookies;
 /**
- * @this {SafariDriver}
- * @returns {Promise<any>}
+ * Delete all cookies visible to the current page.
+ *
+ * @returns Promise that resolves when cookies are deleted
  */
 async function deleteCookies() {
     return await this.safari.proxy.command('/cookie', 'DELETE');
 }
-/**
- * @typedef {import('../driver').SafariDriver} SafariDriver
- */
 //# sourceMappingURL=cookies.js.map

package/build/lib/commands/cookies.js.map

@@ -1 +1 @@
-{"version":3,"file":"cookies.js","sourceRoot":"","sources":["../../../lib/commands/cookies.js"],"names":[],"mappings":";;AAKA,sCAEC;AAND;;;GAGG;AACI,KAAK,UAAU,aAAa;IACjC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;AAC9D,CAAC;AAED;;GAEG"}
+{"version":3,"file":"cookies.js","sourceRoot":"","sources":["../../../lib/commands/cookies.ts"],"names":[],"mappings":";;AAOA,sCAEC;AAPD;;;;GAIG;AACI,KAAK,UAAU,aAAa;IACjC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;AAC9D,CAAC"}

package/build/lib/commands/find.d.ts

@@ -1,12 +1,13 @@
+import type { SafariDriver } from '../driver';
 /**
+ * Find element(s) using the specified strategy and selector.
+ * This is needed to make lookup by image working.
  *
- * @this {SafariDriver}
- * @param {string} strategy
- * @param {string} selector
- * @param {boolean} mult
- * @param {string} [context]
- * @returns {Promise<any>}
+ * @param strategy - The locator strategy to use
+ * @param selector - The selector value
+ * @param mult - Whether to find multiple elements
+ * @param context - Optional context element ID
+ * @returns Promise that resolves to the found element(s)
  */
-export function findElOrEls(this: import("../driver").SafariDriver, strategy: string, selector: string, mult: boolean, context?: string): Promise<any>;
-export type SafariDriver = import("../driver").SafariDriver;
+export declare function findElOrEls(this: SafariDriver, strategy: string, selector: string, mult: boolean, context?: string): Promise<any>;
 //# sourceMappingURL=find.d.ts.map

package/build/lib/commands/find.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"find.d.ts","sourceRoot":"","sources":["../../../lib/commands/find.js"],"names":[],"mappings":"AAGA;;;;;;;;GAQG;AACH,8EANW,MAAM,YACN,MAAM,QACN,OAAO,YACP,MAAM,GACJ,OAAO,CAAC,GAAG,CAAC,CAQxB;2BAGY,OAAO,WAAW,EAAE,YAAY"}
+{"version":3,"file":"find.d.ts","sourceRoot":"","sources":["../../../lib/commands/find.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAE9C;;;;;;;;;GASG;AACH,wBAAsB,WAAW,CAC/B,IAAI,EAAE,YAAY,EAClB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,OAAO,EACb,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,GAAG,CAAC,CAMd"}

package/build/lib/commands/find.js

@@ -2,15 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.findElOrEls = findElOrEls;
 const support_1 = require("appium/support");
-// This is needed to make lookup by image working
 /**
+ * Find element(s) using the specified strategy and selector.
+ * This is needed to make lookup by image working.
  *
- * @this {SafariDriver}
- * @param {string} strategy
- * @param {string} selector
- * @param {boolean} mult
- * @param {string} [context]
- * @returns {Promise<any>}
+ * @param strategy - The locator strategy to use
+ * @param selector - The selector value
+ * @param mult - Whether to find multiple elements
+ * @param context - Optional context element ID
+ * @returns Promise that resolves to the found element(s)
  */
 async function findElOrEls(strategy, selector, mult, context) {
     const endpoint = `/element${context ? `/${support_1.util.unwrapElement(context)}/element` : ''}${mult ? 's' : ''}`;
@@ -19,7 +19,4 @@ async function findElOrEls(strategy, selector, mult, context) {
         value: selector,
     });
 }
-/**
- * @typedef {import('../driver').SafariDriver} SafariDriver
- */
 //# sourceMappingURL=find.js.map

package/build/lib/commands/find.js.map

@@ -1 +1 @@
-{"version":3,"file":"find.js","sourceRoot":"","sources":["../../../lib/commands/find.js"],"names":[],"mappings":";;AAYA,kCAMC;AAlBD,4CAAsC;AAEtC,iDAAiD;AACjD;;;;;;;;GAQG;AACI,KAAK,UAAU,WAAW,CAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO;IAClE,MAAM,QAAQ,GAAG,WAAW,OAAO,CAAC,CAAC,CAAC,IAAI,cAAI,CAAC,aAAa,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IACzG,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE;QACvD,KAAK,EAAE,QAAQ;QACf,KAAK,EAAE,QAAQ;KAChB,CAAC,CAAC;AACL,CAAC;AAED;;GAEG"}
+{"version":3,"file":"find.js","sourceRoot":"","sources":["../../../lib/commands/find.ts"],"names":[],"mappings":";;AAaA,kCAYC;AAzBD,4CAAsC;AAGtC;;;;;;;;;GASG;AACI,KAAK,UAAU,WAAW,CAE/B,QAAgB,EAChB,QAAgB,EAChB,IAAa,EACb,OAAgB;IAEhB,MAAM,QAAQ,GAAG,WAAW,OAAO,CAAC,CAAC,CAAC,IAAI,cAAI,CAAC,aAAa,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IACzG,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE;QACvD,KAAK,EAAE,QAAQ;QACf,KAAK,EAAE,QAAQ;KAChB,CAAC,CAAC;AACL,CAAC"}

package/build/lib/commands/record-screen.d.ts

@@ -1,178 +1,88 @@
-/**
- * @typedef {Object} StartRecordingOptions
- *
- * @property {string} codec [hevc] - Specifies the codec type: "h264" or "hevc"
- * @property {string} display [internal] - Supports "internal" or "external". Default is "internal"
- * @property {string} mask - For non-rectangular displays, handle the mask by policy:
- * - ignored: The mask is ignored and the unmasked framebuffer is saved.
- * - alpha: Not supported, but retained for compatibility; the mask is rendered black.
- * - black: The mask is rendered black.
- * @property {string|number} timeLimit [600] - The maximum recording time, in seconds. The default
- * value is 600 seconds (10 minutes).
- * @property {boolean} forceRestart [true] - Whether to ignore the call if a screen recording is currently running
- * (`false`) or to start a new recording immediately and terminate the existing one if running (`true`).
- */
-/**
- * Record the Simulator's display in background while the automated test is running.
- * This method uses `xcrun simctl io recordVideo` helper under the hood.
- * Check the output of `xcrun simctl io` command for more details.
- *
- * @this {SafariDriver}
- * @param {StartRecordingOptions} options - The available options.
- * @this {import('../driver').SafariDriver}
- * @throws {Error} If screen recording has failed to start or is not supported for the destination device.
- */
-export function startRecordingScreen(this: import("../driver").SafariDriver, options: StartRecordingOptions): Promise<void>;
-export class startRecordingScreen {
-    /**
-     * @typedef {Object} StartRecordingOptions
-     *
-     * @property {string} codec [hevc] - Specifies the codec type: "h264" or "hevc"
-     * @property {string} display [internal] - Supports "internal" or "external". Default is "internal"
-     * @property {string} mask - For non-rectangular displays, handle the mask by policy:
+import type { AppiumLogger } from '@appium/types';
+import type { SafariDriver } from '../driver';
+interface ScreenRecorderOptions {
+    codec?: string;
+    display?: string;
+    mask?: string;
+    timeLimit?: string | number;
+}
+export declare class ScreenRecorder {
+    private log;
+    private _process;
+    private _udid;
+    private _videoPath;
+    private _codec?;
+    private _display?;
+    private _mask?;
+    private _timeLimitMs;
+    private _timer;
+    constructor(udid: string, videoPath: string, log: AppiumLogger, opts?: ScreenRecorderOptions);
+    getVideoPath(): Promise<string>;
+    get isRunning(): boolean;
+    start(): Promise<void>;
+    stop(force?: boolean): Promise<string>;
+    private _enforceTermination;
+}
+export interface StartRecordingOptions {
+    /** Specifies the codec type: "h264" or "hevc" */
+    codec?: string;
+    /** Supports "internal" or "external". Default is "internal" */
+    display?: string;
+    /** For non-rectangular displays, handle the mask by policy:
      * - ignored: The mask is ignored and the unmasked framebuffer is saved.
      * - alpha: Not supported, but retained for compatibility; the mask is rendered black.
      * - black: The mask is rendered black.
-     * @property {string|number} timeLimit [600] - The maximum recording time, in seconds. The default
-     * value is 600 seconds (10 minutes).
-     * @property {boolean} forceRestart [true] - Whether to ignore the call if a screen recording is currently running
-     * (`false`) or to start a new recording immediately and terminate the existing one if running (`true`).
      */
-    /**
-     * Record the Simulator's display in background while the automated test is running.
-     * This method uses `xcrun simctl io recordVideo` helper under the hood.
-     * Check the output of `xcrun simctl io` command for more details.
-     *
-     * @this {SafariDriver}
-     * @param {StartRecordingOptions} options - The available options.
-     * @this {import('../driver').SafariDriver}
-     * @throws {Error} If screen recording has failed to start or is not supported for the destination device.
+    mask?: string;
+    /** The maximum recording time, in seconds. The default value is 600 seconds (10 minutes). */
+    timeLimit?: string | number;
+    /** Whether to ignore the call if a screen recording is currently running
+     * (`false`) or to start a new recording immediately and terminate the existing one if running (`true`).
      */
-    constructor(this: import("../driver").SafariDriver, options: StartRecordingOptions);
-    _screenRecorder: ScreenRecorder;
+    forceRestart?: boolean;
 }
 /**
- * @typedef {Object} StopRecordingOptions
+ * Record the Simulator's display in background while the automated test is running.
+ * This method uses `xcrun simctl io recordVideo` helper under the hood.
+ * Check the output of `xcrun simctl io` command for more details.
  *
- * @property {string} remotePath - The path to the remote location, where the resulting video should be uploaded.
- * The following protocols are supported: http/https, ftp.
- * Null or empty string value (the default setting) means the content of resulting
- * file should be encoded as Base64 and passed as the endpoint response value.
- * An exception will be thrown if the generated media file is too big to
- * fit into the available process memory.
- * @property {string} user - The name of the user for the remote authentication.
- * @property {string} pass - The password for the remote authentication.
- * @property {string} method - The http multipart upload method name. The 'PUT' one is used by default.
- * @property {Object} headers - Additional headers mapping for multipart http(s) uploads
- * @property {string} fileFieldName [file] - The name of the form field, where the file content BLOB should be stored for
- *                                            http(s) uploads
- * @property {Object|[string, string][]} formFields - Additional form fields for multipart http(s) uploads
+ * @param options - The available options.
+ * @throws {Error} If screen recording has failed to start or is not supported for the destination device.
  */
+export declare function startRecordingScreen(this: SafariDriver, options?: StartRecordingOptions): Promise<void>;
+export interface StopRecordingOptions {
+    /** The path to the remote location, where the resulting video should be uploaded.
+     * The following protocols are supported: http/https, ftp.
+     * Null or empty string value (the default setting) means the content of resulting
+     * file should be encoded as Base64 and passed as the endpoint response value.
+     * An exception will be thrown if the generated media file is too big to
+     * fit into the available process memory.
+     */
+    remotePath?: string;
+    /** The name of the user for the remote authentication. */
+    user?: string;
+    /** The password for the remote authentication. */
+    pass?: string;
+    /** The http multipart upload method name. The 'PUT' one is used by default. */
+    method?: string;
+    /** Additional headers mapping for multipart http(s) uploads */
+    headers?: Record<string, string>;
+    /** The name of the form field, where the file content BLOB should be stored for http(s) uploads */
+    fileFieldName?: string;
+    /** Additional form fields for multipart http(s) uploads */
+    formFields?: Record<string, string> | Array<[string, string]>;
+}
 /**
  * Stop recording the screen.
  * If no screen recording has been started before then the method returns an empty string.
  *
- * @this {SafariDriver}
- * @param {StopRecordingOptions} options - The available options.
- * @returns {Promise<string>} Base64-encoded content of the recorded media file if 'remotePath'
+ * @param options - The available options.
+ * @returns Base64-encoded content of the recorded media file if 'remotePath'
  * parameter is falsy or an empty string.
- * @this {import('../driver').SafariDriver}
  * @throws {Error} If there was an error while getting the name of a media file
  * or the file content cannot be uploaded to the remote location
  * or screen recording is not supported on the device under test.
  */
-export function stopRecordingScreen(this: import("../driver").SafariDriver, options: StopRecordingOptions): Promise<string>;
-export type StartRecordingOptions = {
-    /**
-     * [hevc] - Specifies the codec type: "h264" or "hevc"
-     */
-    codec: string;
-    /**
-     * [internal] - Supports "internal" or "external". Default is "internal"
-     */
-    display: string;
-    /**
-     * - For non-rectangular displays, handle the mask by policy:
-     * - ignored: The mask is ignored and the unmasked framebuffer is saved.
-     * - alpha: Not supported, but retained for compatibility; the mask is rendered black.
-     * - black: The mask is rendered black.
-     */
-    mask: string;
-    /**
-     * [600] - The maximum recording time, in seconds. The default
-     * value is 600 seconds (10 minutes).
-     */
-    timeLimit: string | number;
-    /**
-     * [true] - Whether to ignore the call if a screen recording is currently running
-     * (`false`) or to start a new recording immediately and terminate the existing one if running (`true`).
-     */
-    forceRestart: boolean;
-};
-export type StopRecordingOptions = {
-    /**
-     * - The path to the remote location, where the resulting video should be uploaded.
-     * The following protocols are supported: http/https, ftp.
-     * Null or empty string value (the default setting) means the content of resulting
-     * file should be encoded as Base64 and passed as the endpoint response value.
-     * An exception will be thrown if the generated media file is too big to
-     * fit into the available process memory.
-     */
-    remotePath: string;
-    /**
-     * - The name of the user for the remote authentication.
-     */
-    user: string;
-    /**
-     * - The password for the remote authentication.
-     */
-    pass: string;
-    /**
-     * - The http multipart upload method name. The 'PUT' one is used by default.
-     */
-    method: string;
-    /**
-     * - Additional headers mapping for multipart http(s) uploads
-     */
-    headers: any;
-    /**
-     * [file] - The name of the form field, where the file content BLOB should be stored for
-     *           http(s) uploads
-     */
-    fileFieldName: string;
-    /**
-     * - Additional form fields for multipart http(s) uploads
-     */
-    formFields: any | [string, string][];
-};
-export type SafariDriver = import("../driver").SafariDriver;
-declare class ScreenRecorder {
-    /**
-     * @param {string} udid
-     * @param {string} videoPath
-     * @param {import('@appium/types').AppiumLogger} log
-     * @param {{codec?: string, display?: string, mask?: string, timeLimit?: string|number}} [opts={}]
-     */
-    constructor(udid: string, videoPath: string, log: import("@appium/types").AppiumLogger, opts?: {
-        codec?: string;
-        display?: string;
-        mask?: string;
-        timeLimit?: string | number;
-    });
-    log: import("@appium/types").AppiumLogger;
-    _process: any;
-    _udid: string;
-    _videoPath: string;
-    _codec: string | undefined;
-    _display: string | undefined;
-    _mask: string | undefined;
-    _timeLimitMs: number;
-    _timer: NodeJS.Timeout | null;
-    getVideoPath(): Promise<string>;
-    get isRunning(): boolean;
-    _enforceTermination(): Promise<string>;
-    start(): Promise<void>;
-    stop(force?: boolean): Promise<string>;
-}
+export declare function stopRecordingScreen(this: SafariDriver, options?: StopRecordingOptions): Promise<string>;
 export {};
 //# sourceMappingURL=record-screen.d.ts.map

package/build/lib/commands/record-screen.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"record-screen.d.ts","sourceRoot":"","sources":["../../../lib/commands/record-screen.js"],"names":[],"mappings":"AAsNA;;;;;;;;;;;;;GAaG;AAEH;;;;;;;;;GASG;AACH,sFAJW,qBAAqB,iBA6C/B;;IAlED;;;;;;;;;;;;;OAaG;IAEH;;;;;;;;;OASG;IACH,6DAJW,qBAAqB,EA6C/B;IAxBC,gCAA2B;;AA0B7B;;;;;;;;;;;;;;;;GAgBG;AAEH;;;;;;;;;;;;GAYG;AACH,qFARW,oBAAoB,GAClB,OAAO,CAAC,MAAM,CAAC,CAwB3B;;;;;WAjHa,MAAM;;;;aACN,MAAM;;;;;;;UACN,MAAM;;;;;eAIN,MAAM,GAAC,MAAM;;;;;kBAEb,OAAO;;;;;;;;;;;gBA4DP,MAAM;;;;UAMN,MAAM;;;;UACN,MAAM;;;;YACN,MAAM;;;;;;;;;mBAEN,MAAM;;;;gBAEN,MAAO,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE;;2BAoC1B,OAAO,WAAW,EAAE,YAAY;AA/R7C;IACE;;;;;OAKG;IACH,kBALW,MAAM,aACN,MAAM,OACN,OAAO,eAAe,EAAE,YAAY,SACpC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,GAAC,MAAM,CAAA;KAAC,EAkBtF;IAfC,0CAAc;IACd,cAAoB;IACpB,cAAiB;IACjB,mBAA2B;IAC3B,2BAAwB;IACxB,6BAA4B;IAC5B,0BAAsB;IACtB,qBAAyC;IAOzC,8BAAkB;IAGpB,gCAMC;IAED,yBAEC;IAED,uCAcC;IAED,uBA8DC;IAED,uCAuBC;CACF"}
+{"version":3,"file":"record-screen.d.ts","sourceRoot":"","sources":["../../../lib/commands/record-screen.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,YAAY,EAAgB,MAAM,eAAe,CAAC;AAChE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAiD9C,UAAU,qBAAqB;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAC7B;AAED,qBAAa,cAAc;IACzB,OAAO,CAAC,GAAG,CAAe;IAC1B,OAAO,CAAC,QAAQ,CAA2B;IAC3C,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,MAAM,CAAC,CAAS;IACxB,OAAO,CAAC,QAAQ,CAAC,CAAS;IAC1B,OAAO,CAAC,KAAK,CAAC,CAAS;IACvB,OAAO,CAAC,YAAY,CAAiC;IACrD,OAAO,CAAC,MAAM,CAA+B;gBAEhC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,YAAY,EAAE,IAAI,GAAE,qBAA0B;IAe3F,YAAY,IAAK,OAAO,CAAC,MAAM,CAAC;IAQtC,IAAI,SAAS,IAAK,OAAO,CAExB;IAEK,KAAK,IAAK,OAAO,CAAC,IAAI,CAAC;IAgEvB,IAAI,CAAE,KAAK,GAAE,OAAe,GAAG,OAAO,CAAC,MAAM,CAAC;YA6BtC,mBAAmB;CAelC;AA0BD,MAAM,WAAW,qBAAqB;IACpC,iDAAiD;IACjD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+DAA+D;IAC/D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,6FAA6F;IAC7F,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC5B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;;;;GAOG;AACH,wBAAsB,oBAAoB,CACxC,IAAI,EAAE,YAAY,EAClB,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,IAAI,CAAC,CAyCf;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,0DAA0D;IAC1D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kDAAkD;IAClD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,+EAA+E;IAC/E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,mGAAmG;IACnG,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,2DAA2D;IAC3D,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CAC/D;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,mBAAmB,CACvC,IAAI,EAAE,YAAY,EAClB,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,MAAM,CAAC,CAiBjB"}

package/build/lib/commands/record-screen.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScreenRecorder = void 0;
 exports.startRecordingScreen = startRecordingScreen;
 exports.stopRecordingScreen = stopRecordingScreen;
 const lodash_1 = __importDefault(require("lodash"));
@@ -14,13 +15,6 @@ const STARTUP_TIMEOUT_MS = 10 * 1000;
 const DEFAULT_TIME_LIMIT_MS = 60 * 10 * 1000; // 10 minutes
 const PROCESS_SHUTDOWN_TIMEOUT_MS = 10 * 1000;
 const DEFAULT_EXT = '.mp4';
-/**
- *
- * @param {string} localFile
- * @param {string|null} remotePath
- * @param {Object} uploadOptions
- * @returns
- */
 async function uploadRecordedMedia(localFile, remotePath = null, uploadOptions = {}) {
     if (lodash_1.default.isEmpty(remotePath) || !remotePath) {
         return (await support_1.util.toInMemoryBase64(localFile)).toString();
@@ -48,28 +42,28 @@ process.on('exit', () => {
     }
 });
 class ScreenRecorder {
-    /**
-     * @param {string} udid
-     * @param {string} videoPath
-     * @param {import('@appium/types').AppiumLogger} log
-     * @param {{codec?: string, display?: string, mask?: string, timeLimit?: string|number}} [opts={}]
-     */
+    log;
+    _process = null;
+    _udid;
+    _videoPath;
+    _codec;
+    _display;
+    _mask;
+    _timeLimitMs = DEFAULT_TIME_LIMIT_MS;
+    _timer = null;
     constructor(udid, videoPath, log, opts = {}) {
         this.log = log;
-        this._process = null;
         this._udid = udid;
         this._videoPath = videoPath;
         this._codec = opts.codec;
         this._display = opts.display;
         this._mask = opts.mask;
-        this._timeLimitMs = DEFAULT_TIME_LIMIT_MS;
         if (opts.timeLimit) {
             const timeLimitMs = parseInt(String(opts.timeLimit), 10);
             if (timeLimitMs > 0) {
                 this._timeLimitMs = timeLimitMs * 1000;
             }
         }
-        this._timer = null;
     }
     async getVideoPath() {
         if (await support_1.fs.exists(this._videoPath)) {
@@ -81,22 +75,6 @@ class ScreenRecorder {
     get isRunning() {
         return !!(this._process?.isRunning);
     }
-    async _enforceTermination() {
-        if (this.isRunning) {
-            this.log.debug('Force-stopping the currently running video recording');
-            try {
-                await /** @type {import('teen_process').SubProcess} */ (this._process).stop('SIGKILL');
-            }
-            catch { }
-        }
-        this._process = null;
-        const videoPath = await this.getVideoPath();
-        if (videoPath) {
-            await support_1.fs.rimraf(videoPath);
-            VIDEO_FILES.delete(videoPath);
-        }
-        return '';
-    }
     async start() {
         const args = [
             this._udid, 'recordVideo'
@@ -173,8 +151,11 @@ class ScreenRecorder {
             this.log.debug('Screen recording is not running. Returning the recently recorded video');
             return await this.getVideoPath();
         }
+        if (!this._process) {
+            throw new Error('Screen recording process is not available');
+        }
         try {
-            await /** @type {import('teen_process').SubProcess} */ (this._process).stop('SIGINT', PROCESS_SHUTDOWN_TIMEOUT_MS);
+            await this._process.stop('SIGINT', PROCESS_SHUTDOWN_TIMEOUT_MS);
         }
         catch {
             await this._enforceTermination();
@@ -182,7 +163,24 @@ class ScreenRecorder {
         }
         return await this.getVideoPath();
     }
+    async _enforceTermination() {
+        if (this.isRunning && this._process) {
+            this.log.debug('Force-stopping the currently running video recording');
+            try {
+                await this._process.stop('SIGKILL');
+            }
+            catch { }
+        }
+        this._process = null;
+        const videoPath = await this.getVideoPath();
+        if (videoPath) {
+            await support_1.fs.rimraf(videoPath);
+            VIDEO_FILES.delete(videoPath);
+        }
+        return '';
+    }
 }
+exports.ScreenRecorder = ScreenRecorder;
 async function extractSimulatorUdid(caps) {
     if (caps['safari:useSimulator'] === false) {
         return null;
@@ -203,28 +201,12 @@ async function extractSimulatorUdid(caps) {
     }
     return null;
 }
-/**
- * @typedef {Object} StartRecordingOptions
- *
- * @property {string} codec [hevc] - Specifies the codec type: "h264" or "hevc"
- * @property {string} display [internal] - Supports "internal" or "external". Default is "internal"
- * @property {string} mask - For non-rectangular displays, handle the mask by policy:
- * - ignored: The mask is ignored and the unmasked framebuffer is saved.
- * - alpha: Not supported, but retained for compatibility; the mask is rendered black.
- * - black: The mask is rendered black.
- * @property {string|number} timeLimit [600] - The maximum recording time, in seconds. The default
- * value is 600 seconds (10 minutes).
- * @property {boolean} forceRestart [true] - Whether to ignore the call if a screen recording is currently running
- * (`false`) or to start a new recording immediately and terminate the existing one if running (`true`).
- */
 /**
  * Record the Simulator's display in background while the automated test is running.
  * This method uses `xcrun simctl io recordVideo` helper under the hood.
  * Check the output of `xcrun simctl io` command for more details.
  *
- * @this {SafariDriver}
- * @param {StartRecordingOptions} options - The available options.
- * @this {import('../driver').SafariDriver}
+ * @param options - The available options.
  * @throws {Error} If screen recording has failed to start or is not supported for the destination device.
  */
 async function startRecordingScreen(options) {
@@ -262,32 +244,13 @@ async function startRecordingScreen(options) {
         throw e;
     }
 }
-/**
- * @typedef {Object} StopRecordingOptions
- *
- * @property {string} remotePath - The path to the remote location, where the resulting video should be uploaded.
- * The following protocols are supported: http/https, ftp.
- * Null or empty string value (the default setting) means the content of resulting
- * file should be encoded as Base64 and passed as the endpoint response value.
- * An exception will be thrown if the generated media file is too big to
- * fit into the available process memory.
- * @property {string} user - The name of the user for the remote authentication.
- * @property {string} pass - The password for the remote authentication.
- * @property {string} method - The http multipart upload method name. The 'PUT' one is used by default.
- * @property {Object} headers - Additional headers mapping for multipart http(s) uploads
- * @property {string} fileFieldName [file] - The name of the form field, where the file content BLOB should be stored for
- *                                            http(s) uploads
- * @property {Object|[string, string][]} formFields - Additional form fields for multipart http(s) uploads
- */
 /**
  * Stop recording the screen.
  * If no screen recording has been started before then the method returns an empty string.
  *
- * @this {SafariDriver}
- * @param {StopRecordingOptions} options - The available options.
- * @returns {Promise<string>} Base64-encoded content of the recorded media file if 'remotePath'
+ * @param options - The available options.
+ * @returns Base64-encoded content of the recorded media file if 'remotePath'
  * parameter is falsy or an empty string.
- * @this {import('../driver').SafariDriver}
  * @throws {Error} If there was an error while getting the name of a media file
  * or the file content cannot be uploaded to the remote location
  * or screen recording is not supported on the device under test.
@@ -307,9 +270,6 @@ async function stopRecordingScreen(options) {
         const { size } = await support_1.fs.stat(videoPath);
         this.log.debug(`The size of the resulting screen recording is ${support_1.util.toReadableSizeString(size)}`);
     }
-    return await uploadRecordedMedia(videoPath, options?.remotePath, options);
+    return await uploadRecordedMedia(videoPath, options?.remotePath ?? null, options ?? {});
 }
-/**
- * @typedef {import('../driver').SafariDriver} SafariDriver
- */
 //# sourceMappingURL=record-screen.js.map