safaridriver 1.0.1 → 3.0.0

package/README.md

@@ -1,9 +1,11 @@
-# Safaridriver for Node.js [![CI](https://github.com/webdriverio-community/node-safaridriver/actions/workflows/ci.yml/badge.svg)](https://github.com/webdriverio-community/node-safaridriver/actions/workflows/ci.yml) [![Audit](https://github.com/webdriverio-community/node-safaridriver/actions/workflows/audit.yml/badge.svg)](https://github.com/webdriverio-community/node-safaridriver/actions/workflows/audit.yml)
+# Safaridriver for Node.js [![CI](https://github.com/webdriverio/driver/actions/workflows/ci.yml/badge.svg)](https://github.com/webdriverio/driver/actions/workflows/ci.yml) [![Audit](https://github.com/webdriverio/driver/actions/workflows/audit.yml/badge.svg)](https://github.com/webdriverio/driver/actions/workflows/audit.yml)
 
-> A Node.js untility to manage Safaridriver sessions.
+> A Node.js utility to manage Safaridriver sessions.
 
 The Safaridriver utility is used to launch an HTTP server that implements the [WebDriver](https://w3c.github.io/webdriver/) REST API. When launched, Safaridriver allows for automated testing of web content using the version of Safari that is installed with macOS.
 
+__Requirements:__ Node.js 22.19.0 or newer. See [Compatibility](https://github.com/webdriverio/driver#compatibility).
+
 ## Install
 
 To install the package, run:
@@ -19,7 +21,7 @@ To start a Safaridriver server, import the package and run:
 ```js
 import safaridriver from 'safaridriver'
 
-await safaridriver.start()
+safaridriver.start()
 
 // run some automation...
 
@@ -27,6 +29,8 @@ await safaridriver.start()
 safaridriver.stop()
 ```
 
+`start()` returns the [`ChildProcess`](https://nodejs.org/api/child_process.html#class-childprocess). Read its `stdout` and `stderr`, or pass `spawnOpts: { stdio: 'ignore' }`: an unread pipe fills up and then blocks the driver.
+
 ## Options
 
 ### `port`
@@ -45,7 +49,7 @@ __Default:__ `/usr/bin/safaridriver`
 
 ### `useTechnologyPreview`
 
-If set to `true`, it will start the Safaridriver for Safari Technology Preview. Make sure you have it installed by installing Safari Technology Preview on Apple's [offical website](https://developer.apple.com/safari/technology-preview/).
+If set to `true`, it will start the Safaridriver for Safari Technology Preview. Make sure you have it installed by installing Safari Technology Preview on Apple's [official website](https://developer.apple.com/safari/technology-preview/).
 
 __Type:__ `boolean`<br />
 __Default:__ `false`
@@ -66,6 +70,13 @@ Enables diagnostic logging for all sessions hosted by this safaridriver instance
 __Type:__ `boolean`<br />
 __Default:__ `false`
 
+### `spawnOpts`
+
+Options for the Safaridriver process, passed to [`child_process.spawn`](https://nodejs.org/api/child_process.html#child_processspawncommand-args-options).
+
+__Type:__ `SpawnOptions`<br />
+__Default:__ `undefined`
+
 ----
 
-For more information on WebdriverIO see the [homepage](http://webdriver.io).
+For more information on WebdriverIO see the [homepage](https://webdriver.io).

package/dist/cjs/index.d.ts

@@ -1,3 +1,50 @@
-declare const start: (options: never) => Promise<import("node:child_process").ChildProcess>;
-declare const stop: () => Promise<void>;
-//# sourceMappingURL=index.d.ts.map
+import { type ChildProcess, type SpawnOptions } from 'node:child_process';
+export declare const DEFAULT_PATH = "/usr/bin/safaridriver";
+export declare const DEFAULT_STP_PATH = "/Applications/Safari Technology Preview.app/Contents/MacOS/safaridriver";
+export declare const DEFAULT_PORT = 4444;
+export interface SafaridriverOptions {
+    /**
+     * Specifies the port on which the HTTP server should listen for incoming connections.
+     * If the port is already in use or otherwise unavailable, Safaridriver will exit
+     * immediately with a non-zero return code.
+     * @default 4444
+     */
+    port?: number;
+    /**
+     * Path to Safaridriver binary.
+     * @default /usr/bin/safaridriver
+     */
+    path?: string;
+    /**
+     * Applies configuration changes so that subsequent WebDriver sessions will run without
+     * further authentication. This includes checking "Enable Remote Automation" in Safari's
+     * `Develop` menu. The user must authenticate via password for the changes to be applied.
+     *
+     * When this option is specified, safaridriver exits immediately without starting up the
+     * REST API service. If the changes were successful or already applied, safaridriver exits 0;
+     * otherwise, safaridriver exits >0 and prints an error message to stderr.
+     * @default false
+     */
+    enable?: boolean;
+    /**
+     * Enables diagnostic logging for all sessions hosted by this safaridriver instance.
+     * @default false
+     */
+    diagnose?: boolean;
+    /**
+     * If enabled, it starts the Safaridriver binary from the Safari Technology Preview app.
+     */
+    useTechnologyPreview?: boolean;
+    /**
+     * Options for `child_process.spawn`. Pass `{ stdio: 'ignore' }` if you don't read the
+     * driver output: an unread pipe fills up and then blocks the driver.
+     */
+    spawnOpts?: SpawnOptions;
+}
+export declare const start: (options?: SafaridriverOptions) => ChildProcess;
+export declare const stop: () => void;
+declare const _default: {
+    start: typeof start;
+    stop: typeof stop;
+};
+export default _default;

package/dist/cjs/index.js

@@ -1,10 +1,8 @@
-const start = exports.start = async function (options) {
-    const driver = await import('../index.js');
-    return driver.start(options);
-};
-const stop = exports.stop = async function () {
-    const driver = await import('../index.js');
-    return driver.stop();
-};
-module.exports = { start, stop };
+"use strict";
+/**
+ * Node.js 22.12+ can require() the ESM build synchronously, so CommonJS gets
+ * every export of it. dist/cjs/package.json makes this file CommonJS.
+ */
+// oxlint-disable-next-line typescript/no-require-imports
+module.exports = require('../index.js');
 //# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/cjs/index.ts"],"names":[],"mappings":"AAAA,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,GAAG,KAAK,WAAW,OAAc;IACxD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,CAAA;IAC1C,OAAO,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;AAChC,CAAC,CAAA;AAED,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,GAAG,KAAK;IAC7B,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,CAAA;IAC1C,OAAO,MAAM,CAAC,IAAI,EAAE,CAAA;AACxB,CAAC,CAAA;AAED,MAAM,CAAC,OAAO,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/cjs/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;AACH,yDAAyD;AACzD,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,CAAA"}

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import cp from 'node:child_process';
+import { type ChildProcess, type SpawnOptions } from 'node:child_process';
 export declare const DEFAULT_PATH = "/usr/bin/safaridriver";
 export declare const DEFAULT_STP_PATH = "/Applications/Safari Technology Preview.app/Contents/MacOS/safaridriver";
 export declare const DEFAULT_PORT = 4444;
@@ -35,12 +35,17 @@ export interface SafaridriverOptions {
      * If enabled, it starts the Safaridriver binary from the Safari Technology Preview app.
      */
     useTechnologyPreview?: boolean;
+    /**
+     * Options for `child_process.spawn`. Pass `{ stdio: 'ignore' }` if you don't read the
+     * driver output: an unread pipe fills up and then blocks the driver.
+     */
+    spawnOpts?: SpawnOptions;
 }
-export declare const start: (options?: SafaridriverOptions) => cp.ChildProcess;
+export declare const start: (options?: SafaridriverOptions) => ChildProcess;
 export declare const stop: () => void;
 declare const _default: {
-    start: (options?: SafaridriverOptions) => cp.ChildProcess;
-    stop: () => void;
+    start: typeof start;
+    stop: typeof stop;
 };
 export default _default;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAyB,MAAM,oBAAoB,CAAA;AAE1D,eAAO,MAAM,YAAY,0BAA0B,CAAA;AACnD,eAAO,MAAM,gBAAgB,4EAA4E,CAAA;AACzG,eAAO,MAAM,YAAY,OAAO,CAAA;AAEhC,MAAM,WAAW,mBAAmB;IAChC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;CACjC;AAID,eAAO,MAAM,KAAK,GAAI,UAAS,mBAAwB,oBAgCtD,CAAA;AAED,eAAO,MAAM,IAAI,YAKhB,CAAA;;sBAvC8B,mBAAmB;;;AAyClD,wBAA8B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAW,EAAE,KAAK,YAAY,EAAE,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAE7E,eAAO,MAAM,YAAY,0BAA0B,CAAA;AACnD,eAAO,MAAM,gBAAgB,4EAA4E,CAAA;AACzG,eAAO,MAAM,YAAY,OAAO,CAAA;AAEhC,MAAM,WAAW,mBAAmB;IAChC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B;;;OAGG;IACH,SAAS,CAAC,EAAE,YAAY,CAAA;CAC3B;AAID,eAAO,MAAM,KAAK,aAAa,mBAAmB,iBA6CjD,CAAA;AAED,eAAO,MAAM,IAAI,YAKhB,CAAA"}

package/dist/index.js

@@ -4,7 +4,7 @@ export const DEFAULT_PATH = '/usr/bin/safaridriver';
 export const DEFAULT_STP_PATH = '/Applications/Safari Technology Preview.app/Contents/MacOS/safaridriver';
 export const DEFAULT_PORT = 4444;
 let instance;
-let instanceOptions;
+let instancePort;
 export const start = (options = {}) => {
     const port = typeof options.port === 'number' ? options.port : DEFAULT_PORT;
     const args = [`--port=${port}`];
@@ -23,11 +23,24 @@ export const start = (options = {}) => {
         args.push('--diagnose');
     }
     if (instance) {
-        throw new Error(`There is already a Safaridriver instance running on port ${instanceOptions.port}!`);
+        throw new Error(`There is already a Safaridriver instance running on port ${instancePort}!`);
     }
-    instanceOptions = options;
-    instance = cp.execFile(driverPath, args);
-    return instance;
+    // spawn, not execFile: execFile buffers the output and kills the driver after 1 MB of it
+    const child = cp.spawn(driverPath, args, options.spawnOpts ?? {});
+    instance = child;
+    instancePort = port;
+    // `exit` when the driver ran (e.g. `--enable` exits at once), `close` when it failed to start
+    const forget = () => {
+        if (instance === child) {
+            instance = undefined;
+        }
+    };
+    child.once('exit', forget);
+    child.once('close', forget);
+    // execFile listened for `error` itself; without a listener, a missing binary would crash the
+    // caller. Callers still get the error through their own listeners.
+    child.on('error', forget);
+    return child;
 };
 export const stop = () => {
     if (instance) {

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAA;AACxB,OAAO,EAAyB,MAAM,oBAAoB,CAAA;AAE1D,MAAM,CAAC,MAAM,YAAY,GAAG,uBAAuB,CAAA;AACnD,MAAM,CAAC,MAAM,gBAAgB,GAAG,yEAAyE,CAAA;AACzG,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,CAAA;AAqChC,IAAI,QAAsB,CAAA;AAC1B,IAAI,eAAoC,CAAA;AACxC,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,UAA+B,EAAE,EAAE,EAAE;IACvD,MAAM,IAAI,GAAG,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAA;IAC3E,MAAM,IAAI,GAAa,CAAC,UAAU,IAAI,EAAE,CAAC,CAAA;IACzC,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,CAC/B,OAAO,CAAC,oBAAoB;QACxB,CAAC,CAAC,gBAAgB;QAClB,CAAC,CAAC,YAAY,CACrB,CAAA;IAED,MAAM,cAAc,GAAG,OAAO,CAAC,oBAAoB,IAAI,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAA;IACtF,IAAI,OAAO,CAAC,oBAAoB,IAAI,CAAC,cAAc,EAAE,CAAC;QAClD,MAAM,IAAI,KAAK,CACX,2DAA2D;YAC3D,wEAAwE,CAC3E,CAAA;IACL,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACjB,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IACzB,CAAC;IAED,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACnB,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;IAC3B,CAAC;IAED,IAAI,QAAQ,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,4DAA4D,eAAe,CAAC,IAAI,GAAG,CAAC,CAAA;IACxG,CAAC;IAED,eAAe,GAAG,OAAO,CAAA;IACzB,QAAQ,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;IACxC,OAAO,QAAQ,CAAA;AACnB,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,IAAI,GAAG,GAAG,EAAE;IACrB,IAAI,QAAQ,EAAE,CAAC;QACX,QAAQ,CAAC,IAAI,EAAE,CAAA;QACf,QAAQ,GAAG,SAAS,CAAA;IACxB,CAAC;AACL,CAAC,CAAA;AAED,eAAe,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAA;AACxB,OAAO,EAA4C,MAAM,oBAAoB,CAAA;AAE7E,MAAM,CAAC,MAAM,YAAY,GAAG,uBAAuB,CAAA;AACnD,MAAM,CAAC,MAAM,gBAAgB,GAAG,yEAAyE,CAAA;AACzG,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,CAAA;AA0ChC,IAAI,QAAkC,CAAA;AACtC,IAAI,YAAgC,CAAA;AACpC,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,OAAO,GAAwB,EAAE,EAAE,EAAE;IACvD,MAAM,IAAI,GAAG,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAA;IAC3E,MAAM,IAAI,GAAa,CAAC,UAAU,IAAI,EAAE,CAAC,CAAA;IACzC,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,CAC/B,OAAO,CAAC,oBAAoB;QACxB,CAAC,CAAC,gBAAgB;QAClB,CAAC,CAAC,YAAY,CACrB,CAAA;IAED,MAAM,cAAc,GAAG,OAAO,CAAC,oBAAoB,IAAI,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAA;IACtF,IAAI,OAAO,CAAC,oBAAoB,IAAI,CAAC,cAAc,EAAE,CAAC;QAClD,MAAM,IAAI,KAAK,CACX,2DAA2D;YAC3D,wEAAwE,CAC3E,CAAA;IACL,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACjB,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IACzB,CAAC;IAED,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACnB,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;IAC3B,CAAC;IAED,IAAI,QAAQ,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,4DAA4D,YAAY,GAAG,CAAC,CAAA;IAChG,CAAC;IAED,yFAAyF;IACzF,MAAM,KAAK,GAAG,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,CAAA;IACjE,QAAQ,GAAG,KAAK,CAAA;IAChB,YAAY,GAAG,IAAI,CAAA;IACnB,8FAA8F;IAC9F,MAAM,MAAM,GAAG,GAAG,EAAE;QAChB,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;YACrB,QAAQ,GAAG,SAAS,CAAA;QACxB,CAAC;IACL,CAAC,CAAA;IACD,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC1B,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IAC3B,6FAA6F;IAC7F,mEAAmE;IACnE,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IACzB,OAAO,KAAK,CAAA;AAChB,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,IAAI,GAAG,GAAG,EAAE;IACrB,IAAI,QAAQ,EAAE,CAAC;QACX,QAAQ,CAAC,IAAI,EAAE,CAAA;QACf,QAAQ,GAAG,SAAS,CAAA;IACxB,CAAC;AACL,CAAC,CAAA;AAED,eAAe,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA"}

package/package.json

@@ -1,13 +1,14 @@
 {
     "name": "safaridriver",
-    "version": "1.0.1",
+    "version": "3.0.0",
     "author": "Christian Bromann <mail@bromann.dev>",
     "license": "MIT",
     "description": "An NPM wrapper for handling the Safaridriver binary.",
-    "homepage": "https://github.com/webdriverio-community/node-safaridriver#readme",
+    "homepage": "https://github.com/webdriverio/driver/tree/main/packages/node-safaridriver#readme",
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/webdriverio-community/node-safaridriver.git"
+        "url": "git+https://github.com/webdriverio/driver.git",
+        "directory": "packages/node-safaridriver"
     },
     "keywords": [
         "safari",
@@ -17,46 +18,36 @@
         "selenium"
     ],
     "bugs": {
-        "url": "https://github.com/webdriverio-community/node-safaridriver/issues"
+        "url": "https://github.com/webdriverio/driver/issues"
     },
     "engines": {
-        "node": ">=18.0.0"
+        "node": ">=22.19.0"
     },
     "main": "./dist/cjs/index.js",
     "type": "module",
     "module": "./dist/index.js",
     "exports": {
-        ".": [
-            {
+        ".": {
+            "import": {
                 "types": "./dist/index.d.ts",
-                "import": "./dist/index.js",
-                "require": "./dist/cjs/index.js"
+                "default": "./dist/index.js"
             },
-            "./dist/cjs/index.js"
-        ]
+            "require": {
+                "types": "./dist/cjs/index.d.ts",
+                "default": "./dist/cjs/index.js"
+            }
+        }
     },
-    "types": "./dist/index.d.ts",
-    "typeScriptVersion": "3.8.3",
+    "types": "./dist/cjs/index.d.ts",
     "scripts": {
-        "build": "tsc -b .",
-        "ci": "run-s lint build test",
-        "clean": "rimraf ./node_modules package-lock.yaml ./dist",
-        "prepare": "husky install",
+        "build": "tsc -b . && node ../../scripts/copy-cjs-pkg.mjs",
+        "clean": "rimraf ./dist ./tsconfig.tsbuildinfo",
         "test": "run-s test:*",
-        "test:lint": "eslint src tests",
-        "test:unit": "vitest run",
+        "test:lint": "oxlint .",
+        "test:typecheck": "tsc -p tsconfig.test.json",
+        "test:unit": "vitest run --coverage",
         "test:interop": "node ./tests/interop/cjs.test.js",
-        "watch": "npm run build -- --watch"
-    },
-    "devDependencies": {
-        "@types/node": "^25.0.3",
-        "@vitest/coverage-v8": "^4.0.16",
-        "@wdio/eslint": "^0.1.3",
-        "eslint": "^9.39.2",
-        "husky": "^9.1.7",
-        "npm-run-all2": "^8.0.4",
-        "release-it": "^19.2.2",
-        "typescript": "^5.9.3",
-        "vitest": "^4.0.16"
+        "check:pack": "node ../../scripts/check-pack.mjs && publint && attw --pack . --ignore-rules false-export-default",
+        "watch": "pnpm run build -- --watch"
     }
 }

package/src/cjs/index.ts

@@ -0,0 +1,6 @@
+/**
+ * Node.js 22.12+ can require() the ESM build synchronously, so CommonJS gets
+ * every export of it. dist/cjs/package.json makes this file CommonJS.
+ */
+// oxlint-disable-next-line typescript/no-require-imports
+module.exports = require('../index.js')

package/src/cjs/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "commonjs"
+}

package/src/index.ts

@@ -0,0 +1,104 @@
+import fs from 'node:fs'
+import cp, { type ChildProcess, type SpawnOptions } from 'node:child_process'
+
+export const DEFAULT_PATH = '/usr/bin/safaridriver'
+export const DEFAULT_STP_PATH = '/Applications/Safari Technology Preview.app/Contents/MacOS/safaridriver'
+export const DEFAULT_PORT = 4444
+
+export interface SafaridriverOptions {
+    /**
+     * Specifies the port on which the HTTP server should listen for incoming connections.
+     * If the port is already in use or otherwise unavailable, Safaridriver will exit
+     * immediately with a non-zero return code.
+     * @default 4444
+     */
+    port?: number
+    /**
+     * Path to Safaridriver binary.
+     * @default /usr/bin/safaridriver
+     */
+    path?: string
+    /**
+     * Applies configuration changes so that subsequent WebDriver sessions will run without
+     * further authentication. This includes checking "Enable Remote Automation" in Safari's
+     * `Develop` menu. The user must authenticate via password for the changes to be applied.
+     *
+     * When this option is specified, safaridriver exits immediately without starting up the
+     * REST API service. If the changes were successful or already applied, safaridriver exits 0;
+     * otherwise, safaridriver exits >0 and prints an error message to stderr.
+     * @default false
+     */
+    enable?: boolean
+    /**
+     * Enables diagnostic logging for all sessions hosted by this safaridriver instance.
+     * @default false
+     */
+    diagnose?: boolean
+    /**
+     * If enabled, it starts the Safaridriver binary from the Safari Technology Preview app.
+     */
+    useTechnologyPreview?: boolean
+    /**
+     * Options for `child_process.spawn`. Pass `{ stdio: 'ignore' }` if you don't read the
+     * driver output: an unread pipe fills up and then blocks the driver.
+     */
+    spawnOpts?: SpawnOptions
+}
+
+let instance: ChildProcess | undefined
+let instancePort: number | undefined
+export const start = (options: SafaridriverOptions = {}) => {
+    const port = typeof options.port === 'number' ? options.port : DEFAULT_PORT
+    const args: string[] = [`--port=${port}`]
+    const driverPath = options.path || (
+        options.useTechnologyPreview
+            ? DEFAULT_STP_PATH
+            : DEFAULT_PATH
+    )
+
+    const isSTPInstalled = options.useTechnologyPreview && fs.existsSync(DEFAULT_STP_PATH)
+    if (options.useTechnologyPreview && !isSTPInstalled) {
+        throw new Error(
+            'Safari Technology Preview is not installed! Please go to ' +
+            'https://developer.apple.com/safari/technology-preview/ and install it.'
+        )
+    }
+
+    if (options.enable) {
+        args.push('--enable')
+    }
+
+    if (options.diagnose) {
+        args.push('--diagnose')
+    }
+
+    if (instance) {
+        throw new Error(`There is already a Safaridriver instance running on port ${instancePort}!`)
+    }
+
+    // spawn, not execFile: execFile buffers the output and kills the driver after 1 MB of it
+    const child = cp.spawn(driverPath, args, options.spawnOpts ?? {})
+    instance = child
+    instancePort = port
+    // `exit` when the driver ran (e.g. `--enable` exits at once), `close` when it failed to start
+    const forget = () => {
+        if (instance === child) {
+            instance = undefined
+        }
+    }
+    child.once('exit', forget)
+    child.once('close', forget)
+    // execFile listened for `error` itself; without a listener, a missing binary would crash the
+    // caller. Callers still get the error through their own listeners.
+    child.on('error', forget)
+    return child
+}
+
+export const stop = () => {
+    if (instance) {
+        instance.kill()
+        instance = undefined
+    }
+}
+
+export default { start, stop }

package/dist/cjs/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cjs/index.ts"],"names":[],"mappings":"AAAA,QAAA,MAAM,KAAK,YAA4C,KAAK,uDAG3D,CAAA;AAED,QAAA,MAAM,IAAI,qBAGT,CAAA"}

package/dist/tsconfig.tsbuildinfo

@@ -1 +0,0 @@
-{"root":["../src/index.ts","../src/cjs/index.ts","../src/cjs/package.json"],"version":"5.9.3"}