@wdio/firefox-profile-service 10.0.0-alpha.18 → 10.0.0

package/AGENTS.md

@@ -0,0 +1,16 @@
+# @wdio/firefox-profile-service
+
+`FirefoxProfileLauncher#onPrepare` encodes a Firefox profile and writes it to
+`moz:firefoxOptions.profile`. Tests live in `tests/launcher.test.ts`.
+
+- Drive the service through `onPrepare`. Empty options must use a Firefox
+  capability. A non-Firefox capability stays unchanged even if that early
+  return is removed, so it does not prove the return.
+- `profileDirectory` is not a Firefox preference. Assert that `setPreference`
+  is not called for it. `FirefoxProfile.copy` is the proof this option uses
+  the async copy API: the shared mock encodes every profile as `foobar`, so
+  the capability string cannot tell copy from `new Profile()`.
+- Do not call `_setPreferences` or `_buildExtension` just to hit a missing
+  profile. `firefox-profile` `copy` resolves to a profile or rejects.
+  `onPrepare` narrows the optional callback result once; the helpers assume
+  that already happened.

package/README.md

@@ -30,8 +30,7 @@ export const config = {
                 '/path/to/extensionB' // or path to unpacked Firefox extension
             ],
             'xpinstall.signatures.required': false,
-            'browser.startup.homepage': 'https://webdriver.io',
-            legacy: true // only use for firefox <= 55
+            'browser.startup.homepage': 'https://webdriver.io'
         }]
     ],
     // ...
@@ -48,20 +47,24 @@ Contains all settings as key-value pair. You can find all available settings on
 
 ### extensions
 
+<Option type="String[]" default="[]">
+
 Add one or multiple extensions to the browser session. All entries can be either an absolute path to the `.xpi` file or the path to an unpacked Firefox extension directory.
 
-Type: `String[]`<br />
-Default: `[]`
+</Option>
 
 ### profileDirectory
 
+<Option type="String" default="null">
+
 Create Firefox profile based on an existing one by setting an absolute path to that profile.
 
-Type: `String`<br />
-Default: `null`
+</Option>
 
 ### proxy
 
+<Option type="Object" default="null">
+
 Set network proxy settings. The parameter `proxy` is a hash whose structure depends on the value of the mandatory `proxyType` key, which takes one of the following string values:
 
  * `direct` - direct connection (no proxy)
@@ -69,8 +72,7 @@ Set network proxy settings. The parameter `proxy` is a hash whose structure depe
  * `pac` - use an automatic proxy configuration set based on the value of `autoconfigUrl` key
  * `manual` - manual proxy settings defined separately for different protocols using values from the following keys: `ftpProxy`, `httpProxy`, `sslProxy`, `socksProxy`
 
-Type: `Object`<br />
-Default: `null`<br />
+</Option>
 Example:
 
 - Automatic Proxy:
@@ -125,13 +127,8 @@ Example:
     };
     ```
 
-### legacy
-
-Please set this flag to `true` if you use Firefox v55 or lower.
-
-Type: `Boolean`<br />
-Default: `false`
-
 ----
 
 For more information on WebdriverIO see the [homepage](https://webdriver.io).
+
+

package/build/index.js

@@ -26,25 +26,21 @@ var FirefoxProfileLauncher = class {
    * Sets any preferences and proxy
    */
   _setPreferences() {
-    if (!this._profile) {
-      return;
-    }
+    const profile = this._profile;
     for (const [preference, value] of Object.entries(this._options)) {
-      if (["extensions", "proxy", "legacy", "profileDirectory"].includes(preference)) {
+      if (["extensions", "proxy", "profileDirectory"].includes(preference)) {
         continue;
       }
-      this._profile.setPreference(preference, value);
+      profile.setPreference(preference, value);
     }
     if (this._options.proxy) {
-      this._profile.setProxy(this._options.proxy);
+      profile.setProxy(this._options.proxy);
     }
-    this._profile.updatePreferences();
+    profile.updatePreferences();
   }
   async _buildExtension(capabilities) {
-    if (!this._profile) {
-      return;
-    }
-    const zippedProfile = await promisify(this._profile.encoded.bind(this._profile))();
+    const profile = this._profile;
+    const zippedProfile = await promisify(profile.encoded.bind(profile))();
     if (Array.isArray(capabilities)) {
       capabilities.flatMap((c) => {
         if (Object.values(c).length > 0 && Object.values(c).every((c2) => typeof c2 === "object" && c2.capabilities)) {

package/build/launcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE/C,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAA;AAEvD,MAAM,CAAC,OAAO,OAAO,sBAAsB;IAE3B,OAAO,CAAC,QAAQ;IAD5B,OAAO,CAAC,QAAQ,CAAC,CAAS;gBACN,QAAQ,EAAE,qBAAqB;IAE7C,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,YAAY,CAAC,sBAAsB;IA4BhF;;OAEG;IACH,eAAe;IAoBT,eAAe,CAAC,YAAY,EAAE,YAAY,CAAC,sBAAsB;IAkCvE,WAAW,CAAC,UAAU,EAAE,YAAY,CAAC,+BAA+B,EAAE,aAAa,EAAE,MAAM;CAM9F"}
+{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE/C,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAA;AAEvD,MAAM,CAAC,OAAO,OAAO,sBAAsB;IAE3B,OAAO,CAAC,QAAQ;IAD5B,OAAO,CAAC,QAAQ,CAAC,CAAS;gBACN,QAAQ,EAAE,qBAAqB;IAE7C,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,YAAY,CAAC,sBAAsB;IA4BhF;;OAEG;IACH,eAAe;IAkBT,eAAe,CAAC,YAAY,EAAE,YAAY,CAAC,sBAAsB;IA+BvE,WAAW,CAAC,UAAU,EAAE,YAAY,CAAC,+BAA+B,EAAE,aAAa,EAAE,MAAM;CAM9F"}

package/build/types.d.ts

@@ -91,12 +91,6 @@ export interface FirefoxProfileOptions extends FirefoxSettings {
      * ```
      */
     proxy?: ProxySettings;
-    /**
-     * Please set this flag to `true` if you use Firefox v55 or lower.
-     *
-     * @default false
-     */
-    legacy?: boolean;
 }
 export {};
 //# sourceMappingURL=types.d.ts.map

package/build/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,KAAK,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAC9C,UAAU,eAAe;IACrB,SAAS,EAAE,QAAQ,CAAC;CACvB;AAED,UAAU,mBAAmB;IACzB,SAAS,EAAE,QAAQ,CAAC;CACvB;AAED,UAAU,sBAAsB;IAC5B,SAAS,EAAE,KAAK,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;CACzB;AAED,UAAU,mBAAmB;IACzB,SAAS,EAAE,QAAQ,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,KAAK,aAAa,GAAG,eAAe,GAAG,mBAAmB,GAAG,sBAAsB,GAAG,mBAAmB,CAAA;AAEzG,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC1D;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IACrB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,KAAK,CAAC,EAAE,aAAa,CAAA;IACrB;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACnB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,KAAK,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAC9C,UAAU,eAAe;IACrB,SAAS,EAAE,QAAQ,CAAC;CACvB;AAED,UAAU,mBAAmB;IACzB,SAAS,EAAE,QAAQ,CAAC;CACvB;AAED,UAAU,sBAAsB;IAC5B,SAAS,EAAE,KAAK,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;CACzB;AAED,UAAU,mBAAmB;IACzB,SAAS,EAAE,QAAQ,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,KAAK,aAAa,GAAG,eAAe,GAAG,mBAAmB,GAAG,sBAAsB,GAAG,mBAAmB,CAAA;AAEzG,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC1D;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IACrB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,KAAK,CAAC,EAAE,aAAa,CAAA;CACxB"}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@wdio/firefox-profile-service",
-  "version": "10.0.0-alpha.18+dbf0f4971",
+  "version": "10.0.0",
   "description": "WebdriverIO service that lets you define your Firefox profile in your wdio.conf.js",
   "author": "Christian Bromann <mail@bromann.dev>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-firefox-profile-service",
   "license": "MIT",
   "engines": {
-    "node": ">=18.20.0"
+    "node": ">=22.19.0"
   },
   "repository": {
     "type": "git",
@@ -36,13 +36,13 @@
       "types": "./build/index.d.ts"
     }
   },
-  "typeScriptVersion": "3.8.3",
+  "typeScriptVersion": "6.0.3",
   "dependencies": {
-    "@wdio/types": "10.0.0-alpha.18+dbf0f4971",
-    "firefox-profile": "^4.5.0"
+    "@wdio/types": "10.0.0",
+    "firefox-profile": "^4.7.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "dbf0f497130676040ce4212d9cf6459adfe16c42"
+  "gitHead": "38bd5ff4dccfaadccce4bd678286f00594623da2"
 }