@azure/microsoft-playwright-testing 1.0.0-alpha.20241128.1 → 1.0.0-alpha.20241129.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Release History
 
-## 1.0.0-beta.6 (Unreleased)
+## 1.0.0-beta.7 (Unreleased)
 
 ### Features Added
 
@@ -10,19 +10,28 @@
 
 ### Other Changes
 
+## 1.0.0-beta.6 (2024-11-29)
+
+### Features Added
+
+- Added support for multiple global setup and teardown files introduced in playwright v1.49.
+
+### Bugs Fixed
+
+- Missing type generation for some functions and interfaces.
+
 ## 1.0.0-beta.5 (2024-11-18)
 
 This release fixes a bug related to artifact upload and performance enhancements.
 
 ### Bugs Fixed
 
--Fixed failures when uploading artifacts due to race conditions.
+- Fixed failures when uploading artifacts due to race conditions.
 
 ### Other Changes
 
 - Removed runName support in cloud hosted browser uri
-
--Added X-MS-Package-Version header to API that requests cloud hosted browser for language and package version decoding.
+- Added X-MS-Package-Version header to API that requests cloud hosted browser for language and package version decoding.
 
 ## 1.0.0-beta.4 (2024-10-21)
 

package/dist/common/types.d.ts

@@ -95,49 +95,6 @@ export type ConnectOptions = {
 export type BrowserConnectOptions = EndpointOptions & {
     options: ConnectOptions;
 };
-/**
- * @public
- *
- * Base playwright configuration inputs required for generating the service config.
- */
-export type PlaywrightConfigInput = {
-    /**
-     * @public
-     *
-     * Path to the global setup file. This file will be required and run before all the tests. It must export a single
-     * function that takes a [`TestConfig`] argument.
-     *
-     * Learn more about {@link https://playwright.dev/docs/test-global-setup-teardown | global setup and teardown}.
-     */
-    globalSetup?: string | string[];
-    /**
-     * @public
-     *
-     * Path to the global teardown file. This file will be required and run after all the tests. It must export a single
-     * function. See also
-     * {@link https://playwright.dev/docs/api/class-testconfig#test-config-global-teardown | testConfig.globalTeardown}.
-     *
-     * Learn more about {@link https://playwright.dev/docs/test-global-setup-teardown | global setup and teardown}.
-     */
-    globalTeardown?: string | string[];
-};
-/**
- * @public
- *
- * Playwright configuration integrated with Microsoft Playwright Testing.
- *
- * @remarks
- *
- * GlobalSetup and globalTeardown wraps around any existing global setup
- * and teardown present in the base playwright configuration and runs it.
- */
-export type PlaywrightConfig = {
-    use?: {
-        connectOptions: BrowserConnectOptions;
-    };
-    globalSetup?: string | string[];
-    globalTeardown?: string | string[];
-};
 /**
  * @public
  *

package/dist/common/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/common/types.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAEvD,MAAM,MAAM,UAAU,GAAG;IACvB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG;IAC3C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;OAIG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,qBAAqB,GAAG,eAAe,GAAG;IACpD,OAAO,EAAE,cAAc,CAAC;CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAEhC;;;;;;;;OAQG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CACpC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,CAAC,EAAE;QACJ,cAAc,EAAE,qBAAqB,CAAC;KACvC,CAAC;IACF,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAChC,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CACpC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,kBAAkB,CAAC;IAErC;;;;;;OAMG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;OAMG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,OAAO,SAAS,CAAC,CAAC;AAEhE;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAC;AAEhF,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC;AACF,MAAM,MAAM,eAAe,GAAG;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KACvB,CAAC;CACH,CAAC;AACF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AACD,MAAM,MAAM,WAAW,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAE9E,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,MAAM,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACrE,MAAM,EAAE,UAAU,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAEzC,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACtD,oBAAoB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC;CAClD,CAAC;AAIF,MAAM,WAAW,UAAU;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/common/types.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAEvD,MAAM,MAAM,UAAU,GAAG;IACvB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG;IAC3C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;OAIG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,qBAAqB,GAAG,eAAe,GAAG;IACpD,OAAO,EAAE,cAAc,CAAC;CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,kBAAkB,CAAC;IAErC;;;;;;OAMG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;OAMG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,OAAO,SAAS,CAAC,CAAC;AAEhE;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAC;AAEhF,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC;AACF,MAAM,MAAM,eAAe,GAAG;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KACvB,CAAC;CACH,CAAC;AACF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AACD,MAAM,MAAM,WAAW,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAE9E,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,MAAM,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACrE,MAAM,EAAE,UAAU,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAEzC,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACtD,oBAAoB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC;CAClD,CAAC;AAIF,MAAM,WAAW,UAAU;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}

package/dist/common/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/common/types.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { Location, TestStep } from \"@playwright/test/reporter\";\nimport type { ServiceAuth, ServiceOS } from \"./constants\";\nimport type { TokenCredential } from \"@azure/identity\";\n\nexport type JwtPayload = {\n  aid?: string;\n  iss?: string;\n  sub?: string;\n  aud?: string[] | string;\n  exp?: number;\n  nbf?: number;\n  iat?: number;\n  jti?: string;\n};\n\nexport type AccessTokenClaims = JwtPayload & {\n  aid?: string;\n  accountId?: string;\n};\n\n/**\n * @public\n *\n * Endpoint options for the service.\n */\nexport type EndpointOptions = {\n  /**\n   * @public\n   *\n   * A browser websocket endpoint to connect to.\n   */\n  wsEndpoint: string;\n};\n\n/**\n * @public\n *\n * Connect options for the service.\n */\nexport type ConnectOptions = {\n  /**\n   * @public\n   *\n   * Additional HTTP headers to be sent with web socket connect request.\n   */\n  headers?: { [key: string]: string };\n\n  /**\n   * @public\n   *\n   * Exposes network available on the connecting client to the browser being connected to.\n   *\n   * @defaultValue `<loopback>`\n   */\n  exposeNetwork?: string;\n\n  /**\n   * @public\n   *\n   * Maximum time in milliseconds to wait for the connection to be established.\n   *\n   * @defaultValue `30000`\n   */\n  timeout?: number;\n\n  /**\n   * @public\n   *\n   * Slows down Playwright operations by the specified amount of milliseconds.\n   *\n   * @defaultValue `0`\n   */\n  slowMo?: number;\n};\n\n/**\n * @public\n *\n * Browser connect options for the service. This includes endpoint options and connect options.\n *\n * @example\n * ```\n * import playwright, { test, expect, BrowserType } from \"@playwright/test\";\n * import { getConnectOptions, BrowserConnectOptions } from \"@azure/microsoft-playwright-testing\";\n *\n * test(\"has title\", async ({ browserName }) => {\n *  const { wsEndpoint, options } : BrowserConnectOptions = await getConnectOptions();\n *  const browser = await (playwright[browserName] as BrowserType).connect(wsEndpoint, options);\n *  const context = await browser.newContext();\n *  const page = await context.newPage();\n *\n *  await page.goto(\"https://playwright.dev/\");\n *  await expect(page).toHaveTitle(/Playwright/);\n *\n *  await page.close();\n *  await context.close();\n *  await browser.close();\n * });\n * ```\n */\nexport type BrowserConnectOptions = EndpointOptions & {\n  options: ConnectOptions;\n};\n\n/**\n * @public\n *\n * Base playwright configuration inputs required for generating the service config.\n */\nexport type PlaywrightConfigInput = {\n  /**\n   * @public\n   *\n   * Path to the global setup file. This file will be required and run before all the tests. It must export a single\n   * function that takes a [`TestConfig`] argument.\n   *\n   * Learn more about {@link https://playwright.dev/docs/test-global-setup-teardown | global setup and teardown}.\n   */\n  globalSetup?: string | string[];\n\n  /**\n   * @public\n   *\n   * Path to the global teardown file. This file will be required and run after all the tests. It must export a single\n   * function. See also\n   * {@link https://playwright.dev/docs/api/class-testconfig#test-config-global-teardown | testConfig.globalTeardown}.\n   *\n   * Learn more about {@link https://playwright.dev/docs/test-global-setup-teardown | global setup and teardown}.\n   */\n  globalTeardown?: string | string[];\n};\n\n/**\n * @public\n *\n * Playwright configuration integrated with Microsoft Playwright Testing.\n *\n * @remarks\n *\n * GlobalSetup and globalTeardown wraps around any existing global setup\n * and teardown present in the base playwright configuration and runs it.\n */\nexport type PlaywrightConfig = {\n  use?: {\n    connectOptions: BrowserConnectOptions;\n  };\n  globalSetup?: string | string[];\n  globalTeardown?: string | string[];\n};\n\n/**\n * @public\n *\n * Additional options for the service.\n */\nexport type PlaywrightServiceAdditionalOptions = {\n  /**\n   * @public\n   *\n   * Authentication types supported by Microsoft Playwright Testing.\n   *\n   * @defaultValue  `ENTRA_ID`\n   */\n  serviceAuthType?: AuthenticationType;\n\n  /**\n   * @public\n   *\n   * Operating system types supported by Microsoft Playwright Testing.\n   *\n   * @defaultValue  `linux`\n   */\n  os?: OsType;\n\n  /**\n   * @public\n   *\n   * Run id for the test run.\n   *\n   * @defaultValue `current datetime as ISO string`\n   */\n  runId?: string;\n\n  /**\n   * @public\n   *\n   * Maximum time in milliseconds to wait for the connection to be established.\n   *\n   * @defaultValue `30000`\n   */\n  timeout?: number;\n\n  /**\n   * @public\n   *\n   * Slows down Playwright operations by the specified amount of milliseconds.\n   *\n   * @defaultValue `0`\n   */\n  slowMo?: number;\n\n  /**\n   * @public\n   *\n   * Exposes network available on the connecting client to the browser being connected to.\n   *\n   * @defaultValue `<loopback>`\n   */\n  exposeNetwork?: string;\n\n  /**\n   * @public\n   *\n   * Use cloud hosted browsers.\n   *\n   * @defaultValue `false`\n   */\n  useCloudHostedBrowsers?: boolean;\n\n  /**\n   * @public\n   *\n   * Custom token credential for Entra ID authentication. Learn more at {@link https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/using-azure-identity.md | Using Azure Identity}.\n   *\n   * @defaultValue `DefaultAzureCredential`\n   */\n  credential?: TokenCredential;\n  /**\n   * @public\n   *\n   * Run name for the test run.\n   *\n   * @defaultValue `guid`\n   */\n  runName?: string;\n};\n\n/**\n * @public\n *\n * OS Types supported by Microsoft Playwright Testing.\n */\nexport type OsType = (typeof ServiceOS)[keyof typeof ServiceOS];\n\n/**\n * @public\n *\n * Authentication types supported by Microsoft Playwright Testing.\n */\nexport type AuthenticationType = (typeof ServiceAuth)[keyof typeof ServiceAuth];\n\nexport type ErrorDetails = {\n  message: string;\n  location?: Location;\n};\nexport type ApiErrorMessage = {\n  [key: string]: {\n    [key: number]: string;\n  };\n};\n/**\n * @public\n *\n * Optional configuration for MPT Reporter.\n *\n * @example\n *\n * ```\n * import { defineConfig } from \"@playwright/test\";\n *\n * export default defineConfig({\n *  reporter: [[\"@azure/microsoft-playwright-testing/reporter\", {\n *   enableGitHubSummary: true\n *  }]],\n * });\n * ```\n */\nexport interface MPTReporterConfig {\n  /**\n   * @public\n   *\n   * Enable GitHub Actions annotations to diagnose test failures and deep link to MPT Portal.\n   *\n   * @defaultValue `true`\n   */\n  enableGitHubSummary?: boolean;\n\n  /**\n   * @public\n   *\n   * Enable result publishing for the test run. This will upload the test result and artifacts to the MPT Portal.\n   *\n   * @defaultValue `true`\n   */\n  enableResultPublish?: boolean;\n}\nexport type DedupedStep = { step: TestStep; count: number; duration: number };\n\nexport type RawTestStep = {\n  title: string;\n  category: string;\n  startTime: string;\n  duration: number;\n  error?: string;\n  steps: RawTestStep[];\n  location?: Location;\n  snippet?: string;\n  count: number;\n};\n\nexport type IBackOffOptions = {\n  numOfAttempts: number;\n  retry: (e: any, attemptNumber: number) => boolean | Promise<boolean>;\n  jitter: JitterType;\n};\n\nexport type JitterType = \"full\" | \"none\";\n\nexport type VersionInfo = {\n  major: number;\n  minor: number;\n  patch: number;\n};\n\nexport type PackageManager = {\n  runCommand: (command: string, args: string) => string;\n  getVersionFromStdout: (stdout: string) => string;\n};\n\n// Playwright OSS Types\n\nexport interface FullConfig {\n  configFile?: string;\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/common/types.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { Location, TestStep } from \"@playwright/test/reporter\";\nimport type { ServiceAuth, ServiceOS } from \"./constants\";\nimport type { TokenCredential } from \"@azure/identity\";\n\nexport type JwtPayload = {\n  aid?: string;\n  iss?: string;\n  sub?: string;\n  aud?: string[] | string;\n  exp?: number;\n  nbf?: number;\n  iat?: number;\n  jti?: string;\n};\n\nexport type AccessTokenClaims = JwtPayload & {\n  aid?: string;\n  accountId?: string;\n};\n\n/**\n * @public\n *\n * Endpoint options for the service.\n */\nexport type EndpointOptions = {\n  /**\n   * @public\n   *\n   * A browser websocket endpoint to connect to.\n   */\n  wsEndpoint: string;\n};\n\n/**\n * @public\n *\n * Connect options for the service.\n */\nexport type ConnectOptions = {\n  /**\n   * @public\n   *\n   * Additional HTTP headers to be sent with web socket connect request.\n   */\n  headers?: { [key: string]: string };\n\n  /**\n   * @public\n   *\n   * Exposes network available on the connecting client to the browser being connected to.\n   *\n   * @defaultValue `<loopback>`\n   */\n  exposeNetwork?: string;\n\n  /**\n   * @public\n   *\n   * Maximum time in milliseconds to wait for the connection to be established.\n   *\n   * @defaultValue `30000`\n   */\n  timeout?: number;\n\n  /**\n   * @public\n   *\n   * Slows down Playwright operations by the specified amount of milliseconds.\n   *\n   * @defaultValue `0`\n   */\n  slowMo?: number;\n};\n\n/**\n * @public\n *\n * Browser connect options for the service. This includes endpoint options and connect options.\n *\n * @example\n * ```\n * import playwright, { test, expect, BrowserType } from \"@playwright/test\";\n * import { getConnectOptions, BrowserConnectOptions } from \"@azure/microsoft-playwright-testing\";\n *\n * test(\"has title\", async ({ browserName }) => {\n *  const { wsEndpoint, options } : BrowserConnectOptions = await getConnectOptions();\n *  const browser = await (playwright[browserName] as BrowserType).connect(wsEndpoint, options);\n *  const context = await browser.newContext();\n *  const page = await context.newPage();\n *\n *  await page.goto(\"https://playwright.dev/\");\n *  await expect(page).toHaveTitle(/Playwright/);\n *\n *  await page.close();\n *  await context.close();\n *  await browser.close();\n * });\n * ```\n */\nexport type BrowserConnectOptions = EndpointOptions & {\n  options: ConnectOptions;\n};\n\n/**\n * @public\n *\n * Additional options for the service.\n */\nexport type PlaywrightServiceAdditionalOptions = {\n  /**\n   * @public\n   *\n   * Authentication types supported by Microsoft Playwright Testing.\n   *\n   * @defaultValue  `ENTRA_ID`\n   */\n  serviceAuthType?: AuthenticationType;\n\n  /**\n   * @public\n   *\n   * Operating system types supported by Microsoft Playwright Testing.\n   *\n   * @defaultValue  `linux`\n   */\n  os?: OsType;\n\n  /**\n   * @public\n   *\n   * Run id for the test run.\n   *\n   * @defaultValue `current datetime as ISO string`\n   */\n  runId?: string;\n\n  /**\n   * @public\n   *\n   * Maximum time in milliseconds to wait for the connection to be established.\n   *\n   * @defaultValue `30000`\n   */\n  timeout?: number;\n\n  /**\n   * @public\n   *\n   * Slows down Playwright operations by the specified amount of milliseconds.\n   *\n   * @defaultValue `0`\n   */\n  slowMo?: number;\n\n  /**\n   * @public\n   *\n   * Exposes network available on the connecting client to the browser being connected to.\n   *\n   * @defaultValue `<loopback>`\n   */\n  exposeNetwork?: string;\n\n  /**\n   * @public\n   *\n   * Use cloud hosted browsers.\n   *\n   * @defaultValue `false`\n   */\n  useCloudHostedBrowsers?: boolean;\n\n  /**\n   * @public\n   *\n   * Custom token credential for Entra ID authentication. Learn more at {@link https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/using-azure-identity.md | Using Azure Identity}.\n   *\n   * @defaultValue `DefaultAzureCredential`\n   */\n  credential?: TokenCredential;\n  /**\n   * @public\n   *\n   * Run name for the test run.\n   *\n   * @defaultValue `guid`\n   */\n  runName?: string;\n};\n\n/**\n * @public\n *\n * OS Types supported by Microsoft Playwright Testing.\n */\nexport type OsType = (typeof ServiceOS)[keyof typeof ServiceOS];\n\n/**\n * @public\n *\n * Authentication types supported by Microsoft Playwright Testing.\n */\nexport type AuthenticationType = (typeof ServiceAuth)[keyof typeof ServiceAuth];\n\nexport type ErrorDetails = {\n  message: string;\n  location?: Location;\n};\nexport type ApiErrorMessage = {\n  [key: string]: {\n    [key: number]: string;\n  };\n};\n/**\n * @public\n *\n * Optional configuration for MPT Reporter.\n *\n * @example\n *\n * ```\n * import { defineConfig } from \"@playwright/test\";\n *\n * export default defineConfig({\n *  reporter: [[\"@azure/microsoft-playwright-testing/reporter\", {\n *   enableGitHubSummary: true\n *  }]],\n * });\n * ```\n */\nexport interface MPTReporterConfig {\n  /**\n   * @public\n   *\n   * Enable GitHub Actions annotations to diagnose test failures and deep link to MPT Portal.\n   *\n   * @defaultValue `true`\n   */\n  enableGitHubSummary?: boolean;\n\n  /**\n   * @public\n   *\n   * Enable result publishing for the test run. This will upload the test result and artifacts to the MPT Portal.\n   *\n   * @defaultValue `true`\n   */\n  enableResultPublish?: boolean;\n}\nexport type DedupedStep = { step: TestStep; count: number; duration: number };\n\nexport type RawTestStep = {\n  title: string;\n  category: string;\n  startTime: string;\n  duration: number;\n  error?: string;\n  steps: RawTestStep[];\n  location?: Location;\n  snippet?: string;\n  count: number;\n};\n\nexport type IBackOffOptions = {\n  numOfAttempts: number;\n  retry: (e: any, attemptNumber: number) => boolean | Promise<boolean>;\n  jitter: JitterType;\n};\n\nexport type JitterType = \"full\" | \"none\";\n\nexport type VersionInfo = {\n  major: number;\n  minor: number;\n  patch: number;\n};\n\nexport type PackageManager = {\n  runCommand: (command: string, args: string) => string;\n  getVersionFromStdout: (stdout: string) => string;\n};\n\n// Playwright OSS Types\n\nexport interface FullConfig {\n  configFile?: string;\n}\n"]}

package/dist/core/playwrightService.d.ts

@@ -1,4 +1,5 @@
-import type { PlaywrightServiceAdditionalOptions, PlaywrightConfig, PlaywrightConfigInput, BrowserConnectOptions } from "../common/types";
+import type { PlaywrightServiceAdditionalOptions, BrowserConnectOptions } from "../common/types";
+import type { PlaywrightTestConfig } from "@playwright/test";
 /**
  * @public
  *
@@ -29,7 +30,7 @@ import type { PlaywrightServiceAdditionalOptions, PlaywrightConfig, PlaywrightCo
  * }));
  * ```
  */
-declare const getServiceConfig: (config: PlaywrightConfigInput, options?: PlaywrightServiceAdditionalOptions) => PlaywrightConfig;
+declare const getServiceConfig: (config: PlaywrightTestConfig, options?: PlaywrightServiceAdditionalOptions) => PlaywrightTestConfig;
 /**
  * @public
  *

package/dist/core/playwrightService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"playwrightService.d.ts","sourceRoot":"","sources":["../../src/core/playwrightService.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,kCAAkC,EAClC,gBAAgB,EAChB,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,iBAAiB,CAAC;AAgBzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,QAAA,MAAM,gBAAgB,WACZ,qBAAqB,YACnB,kCAAkC,KAC3C,gBA+GF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,QAAA,MAAM,iBAAiB,aACX,IAAI,CAAC,kCAAkC,EAAE,iBAAiB,CAAC,KACpE,OAAO,CAAC,qBAAqB,CAoB/B,CAAC;AAEF,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,CAAC"}
+{"version":3,"file":"playwrightService.d.ts","sourceRoot":"","sources":["../../src/core/playwrightService.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,kCAAkC,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAejG,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,QAAA,MAAM,gBAAgB,WACZ,oBAAoB,YAClB,kCAAkC,KAC3C,oBA+GF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,QAAA,MAAM,iBAAiB,aACX,IAAI,CAAC,kCAAkC,EAAE,iBAAiB,CAAC,KACpE,OAAO,CAAC,qBAAqB,CAoB/B,CAAC;AAEF,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,CAAC"}

package/dist/core/playwrightService.js.map

@@ -1 +1 @@
-{"version":3,"file":"playwrightService.js","sourceRoot":"","sources":["../../src/core/playwrightService.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;AAElC,mDAAgF;AAChF,sFAAsD;AACtD,+EAA4E;AAC5E,8FAA8D;AAO9D,0CAYwB;AACxB,iDAAkE;AAElE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,gBAAgB,GAAG,CACvB,MAA6B,EAC7B,OAA4C,EAC1B,EAAE;IACpB,IAAA,iCAAyB,GAAE,CAAC;IAC5B,IAAA,0BAAkB,GAAE,CAAC;IACrB,MAAM,qBAAqB,GAAG,IAAA,sBAAc,EAAC,IAAA,4BAAoB,GAAE,CAAC,CAAC;IACrE,MAAM,6BAA6B,GACjC,qBAAqB,CAAC,KAAK,IAAI,CAAC,IAAI,qBAAqB,CAAC,KAAK,IAAI,EAAE,CAAC;IACxE,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,EAAE,CAAC;QACxB,gCAAsB,CAAC,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC;IACjE,CAAC;IAED,uCAAuC;IACvC,+DAA+D;IAC/D,gGAAgG;IAEhG,sCAAsC;IACtC,2DAA2D;IAC3D,kGAAkG;IAClG,IAAI,MAAM,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;QACjC,IAAI,OAAO,MAAM,CAAC,WAAW,KAAK,QAAQ,EAAE,CAAC;YAC3C,IAAI,6BAA6B,EAAE,CAAC;gBAClC,wBAAc,CAAC,WAAW,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YACpD,CAAC;iBAAM,CAAC;gBACN,wBAAc,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;YAClD,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,6BAA6B,EAAE,CAAC;gBACnC,MAAM,IAAI,KAAK,CACb,uCAA4B,CAAC,4CAA4C,CAAC,OAAO,CAClF,CAAC;YACJ,CAAC;YACD,wBAAc,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QAClD,CAAC;IACH,CAAC;IAED,IAAI,MAAM,IAAI,MAAM,CAAC,cAAc,EAAE,CAAC;QACpC,IAAI,OAAO,MAAM,CAAC,cAAc,KAAK,QAAQ,EAAE,CAAC;YAC9C,IAAI,6BAA6B,EAAE,CAAC;gBAClC,wBAAc,CAAC,cAAc,GAAG,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;YAC1D,CAAC;iBAAM,CAAC;gBACN,wBAAc,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;YACxD,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,6BAA6B,EAAE,CAAC;gBACnC,MAAM,IAAI,KAAK,CACb,uCAA4B,CAAC,4CAA4C,CAAC,OAAO,CAClF,CAAC;YACJ,CAAC;YACD,wBAAc,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;QACxD,CAAC;IACH,CAAC;IAED,MAAM,uBAAuB,GAAG,IAAI,iDAAuB,EAAE,CAAC;IAC9D,uBAAuB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC5C,IAAA,wBAAgB,GAAE,CAAC;IAEnB,MAAM,eAAe,GAAQ,EAAE,CAAC;IAChC,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe,MAAK,uBAAW,CAAC,YAAY,EAAE,CAAC;QAC1D,uFAAuF;QACvF,IAAA,sBAAc,EAAC,8BAAsB,CAAC,CAAC;IACzC,CAAC;SAAM,CAAC;QACN,qIAAqI;QACrI,IAAI,6BAA6B,EAAE,CAAC;YAClC,eAAe,CAAC,WAAW,GAAG,EAAc,CAAC;YAC7C,eAAe,CAAC,cAAc,GAAG,EAAc,CAAC;YAChD,IAAI,wBAAc,CAAC,WAAW,EAAE,CAAC;gBAC/B,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,GAAI,wBAAc,CAAC,WAAwB,CAAC,CAAC;YAChF,CAAC;YACD,IAAI,wBAAc,CAAC,cAAc,EAAE,CAAC;gBAClC,eAAe,CAAC,cAAc,CAAC,IAAI,CAAC,GAAI,wBAAc,CAAC,cAA2B,CAAC,CAAC;YACtF,CAAC;YACD,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,0CAA0C,CAAC,CAAC,CAAC;YAC9F,eAAe,CAAC,cAAc,CAAC,IAAI,CACjC,OAAO,CAAC,OAAO,CAAC,6CAA6C,CAAC,CAC/D,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,uIAAuI;YACvI,eAAe,CAAC,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,0CAA0C,CAAC,CAAC;YAC1F,eAAe,CAAC,cAAc,GAAG,OAAO,CAAC,OAAO,CAC9C,6CAA6C,CAC9C,CAAC;QACJ,CAAC;IACH,CAAC;IAED,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,sBAAsB,MAAK,KAAK,EAAE,CAAC;QAC9C,yBACK,eAAe,EAClB;IACJ,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wCAA4B,CAAC,6BAA6B,CAAC,EAAE,CAAC;QAC7E,OAAO,CAAC,GAAG,CAAC,wCAA4B,CAAC,6BAA6B,CAAC,GAAG,MAAM,CAAC;QACjF,OAAO,CAAC,GAAG,CAAC,6DAA6D,CAAC,CAAC;IAC7E,CAAC;IAED,uBACE,GAAG,EAAE;YACH,cAAc,EAAE;gBACd,UAAU,EAAE,IAAA,4BAAoB,EAC9B,uBAAuB,CAAC,KAAK,EAC7B,uBAAuB,CAAC,SAAS,CAClC;gBACD,OAAO,EAAE;oBACP,aAAa,EAAE,UAAU,IAAA,sBAAc,GAAE,EAAE;oBAC3C,sBAAsB,EAAE,uCAAuC,IAAA,yBAAiB,GAAE,EAAE;iBACrF;gBACD,OAAO,EAAE,uBAAuB,CAAC,OAAO;gBACxC,aAAa,EAAE,uBAAuB,CAAC,aAAa;gBACpD,MAAM,EAAE,uBAAuB,CAAC,MAAM;aACvC;SACF,IACE,eAAe,EAClB;AACJ,CAAC,CAAC;AAsDO,4CAAgB;AApDzB;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,iBAAiB,GAAG,KAAK,EAC7B,OAAqE,EACrC,EAAE;IAClC,MAAM,uBAAuB,GAAG,IAAI,iDAAuB,EAAE,CAAC;IAC9D,uBAAuB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAE5C,MAAM,KAAK,GAAG,MAAM,IAAA,kCAA0B,EAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,CAAC,CAAC;IACpE,OAAO;QACL,UAAU,EAAE,IAAA,4BAAoB,EAC9B,uBAAuB,CAAC,KAAK,EAC7B,uBAAuB,CAAC,SAAS,CAClC;QACD,OAAO,EAAE;YACP,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,KAAK,EAAE;gBAChC,sBAAsB,EAAE,uCAAuC,IAAA,yBAAiB,GAAE,EAAE;aACrF;YACD,OAAO,EAAE,uBAAuB,CAAC,OAAO;YACxC,aAAa,EAAE,uBAAuB,CAAC,aAAa;YACpD,MAAM,EAAE,uBAAuB,CAAC,MAAM;SACvC;KACF,CAAC;AACJ,CAAC,CAAC;AAEyB,8CAAiB","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { InternalEnvironmentVariables, ServiceAuth } from \"../common/constants\";\nimport customerConfig from \"../common/customerConfig\";\nimport { PlaywrightServiceConfig } from \"../common/playwrightServiceConfig\";\nimport playwrightServiceEntra from \"./playwrightServiceEntra\";\nimport type {\n  PlaywrightServiceAdditionalOptions,\n  PlaywrightConfig,\n  PlaywrightConfigInput,\n  BrowserConnectOptions,\n} from \"../common/types\";\nimport {\n  emitReportingUrl,\n  fetchOrValidateAccessToken,\n  getAccessToken,\n  getServiceWSEndpoint,\n  validateMptPAT,\n  validatePlaywrightVersion,\n  validateServiceUrl,\n  exitWithFailureMessage,\n  getPackageVersion,\n  getPlaywrightVersion,\n  getVersionInfo,\n} from \"../utils/utils\";\nimport { ServiceErrorMessageConstants } from \"../common/messages\";\n\n/**\n * @public\n *\n * Generate playwright configuration integrated with Microsoft Playwright Testing.\n *\n * @param config - base playwright configuration\n * @param options - additional options for the service\n * @returns PlaywrightConfig\n *\n * @example\n * ```\n * import { defineConfig } from \"playwright/test\";\n * import { getServiceConfig } from \"@azure/microsoft-playwright-testing\";\n * import playwrightConfig from \"./playwright.config\";\n *\n * export default defineConfig(playwrightConfig, getServiceConfig(playwrightConfig));\n * ```\n *\n * @example\n * ```\n * import { defineConfig } from \"playwright/test\";\n * import { getServiceConfig, ServiceOS } from \"@azure/microsoft-playwright-testing\";\n * import playwrightConfig from \"./playwright.config\";\n *\n * export default defineConfig(playwrightConfig, getServiceConfig(playwrightConfig, {\n *  runId: \"custom run id\",\n *  os: ServiceOS.WINDOWS\n * }));\n * ```\n */\nconst getServiceConfig = (\n  config: PlaywrightConfigInput,\n  options?: PlaywrightServiceAdditionalOptions,\n): PlaywrightConfig => {\n  validatePlaywrightVersion();\n  validateServiceUrl();\n  const playwrightVersionInfo = getVersionInfo(getPlaywrightVersion());\n  const isMultipleGlobalFileSupported =\n    playwrightVersionInfo.major >= 1 && playwrightVersionInfo.minor >= 49;\n  if (options?.credential) {\n    playwrightServiceEntra.entraIdAccessToken = options.credential;\n  }\n\n  // if global setup/teardown is string -\n  // 1. if multiple global file is supported, convert it to array\n  // 2. wrap playwright-service global setup/teardown with customer provided global setup/teardown\n\n  // if global setup/teardown is array -\n  // 1. if multiple global file is not supported, throw error\n  // 2. append playwright-service global setup/teardown with customer provided global setup/teardown\n  if (config && config.globalSetup) {\n    if (typeof config.globalSetup === \"string\") {\n      if (isMultipleGlobalFileSupported) {\n        customerConfig.globalSetup = [config.globalSetup];\n      } else {\n        customerConfig.globalSetup = config.globalSetup;\n      }\n    } else {\n      if (!isMultipleGlobalFileSupported) {\n        throw new Error(\n          ServiceErrorMessageConstants.MULTIPLE_SETUP_FILE_PLAYWRIGHT_VERSION_ERROR.message,\n        );\n      }\n      customerConfig.globalSetup = config.globalSetup;\n    }\n  }\n\n  if (config && config.globalTeardown) {\n    if (typeof config.globalTeardown === \"string\") {\n      if (isMultipleGlobalFileSupported) {\n        customerConfig.globalTeardown = [config.globalTeardown];\n      } else {\n        customerConfig.globalTeardown = config.globalTeardown;\n      }\n    } else {\n      if (!isMultipleGlobalFileSupported) {\n        throw new Error(\n          ServiceErrorMessageConstants.MULTIPLE_SETUP_FILE_PLAYWRIGHT_VERSION_ERROR.message,\n        );\n      }\n      customerConfig.globalTeardown = config.globalTeardown;\n    }\n  }\n\n  const playwrightServiceConfig = new PlaywrightServiceConfig();\n  playwrightServiceConfig.setOptions(options);\n  emitReportingUrl();\n\n  const globalFunctions: any = {};\n  if (options?.serviceAuthType === ServiceAuth.ACCESS_TOKEN) {\n    // mpt PAT requested and set by the customer, no need to setup entra lifecycle handlers\n    validateMptPAT(exitWithFailureMessage);\n  } else {\n    // If multiple global file is supported, append playwright-service global setup/teardown with customer provided global setup/teardown\n    if (isMultipleGlobalFileSupported) {\n      globalFunctions.globalSetup = [] as string[];\n      globalFunctions.globalTeardown = [] as string[];\n      if (customerConfig.globalSetup) {\n        globalFunctions.globalSetup.push(...(customerConfig.globalSetup as string[]));\n      }\n      if (customerConfig.globalTeardown) {\n        globalFunctions.globalTeardown.push(...(customerConfig.globalTeardown as string[]));\n      }\n      globalFunctions.globalSetup.push(require.resolve(\"./global/playwright-service-global-setup\"));\n      globalFunctions.globalTeardown.push(\n        require.resolve(\"./global/playwright-service-global-teardown\"),\n      );\n    } else {\n      // If multiple global file is not supported, wrap playwright-service global setup/teardown with customer provided global setup/teardown\n      globalFunctions.globalSetup = require.resolve(\"./global/playwright-service-global-setup\");\n      globalFunctions.globalTeardown = require.resolve(\n        \"./global/playwright-service-global-teardown\",\n      );\n    }\n  }\n\n  if (options?.useCloudHostedBrowsers === false) {\n    return {\n      ...globalFunctions,\n    };\n  }\n  if (!process.env[InternalEnvironmentVariables.MPT_CLOUD_HOSTED_BROWSER_USED]) {\n    process.env[InternalEnvironmentVariables.MPT_CLOUD_HOSTED_BROWSER_USED] = \"true\";\n    console.log(\"\\nRunning tests using Microsoft Playwright Testing service.\");\n  }\n\n  return {\n    use: {\n      connectOptions: {\n        wsEndpoint: getServiceWSEndpoint(\n          playwrightServiceConfig.runId,\n          playwrightServiceConfig.serviceOs,\n        ),\n        headers: {\n          Authorization: `Bearer ${getAccessToken()}`,\n          \"x-ms-package-version\": `@azure/microsoft-playwright-testing/${getPackageVersion()}`,\n        },\n        timeout: playwrightServiceConfig.timeout,\n        exposeNetwork: playwrightServiceConfig.exposeNetwork,\n        slowMo: playwrightServiceConfig.slowMo,\n      },\n    },\n    ...globalFunctions,\n  };\n};\n\n/**\n * @public\n *\n * Get connect options required to connect to Microsoft Playwright Testing's cloud hosted browsers.\n *\n * @param options - additional options for the service\n * @returns BrowserConnectOptions\n *\n * @example\n * ```\n * import playwright, { test, expect, BrowserType } from \"@playwright/test\";\n * import { getConnectOptions } from \"@azure/microsoft-playwright-testing\";\n *\n * test('has title', async ({ browserName }) => {\n *  const { wsEndpoint, options } = await getConnectOptions();\n *  const browser = await (playwright[browserName] as BrowserType).connect(wsEndpoint, options);\n *  const context = await browser.newContext();\n *  const page = await context.newPage();\n *\n *  await page.goto('https://playwright.dev/');\n *  await expect(page).toHaveTitle(/Playwright/);\n *\n *  await page.close();\n *  await context.close();\n *  await browser.close();\n * });\n * ```\n */\nconst getConnectOptions = async (\n  options?: Omit<PlaywrightServiceAdditionalOptions, \"serviceAuthType\">,\n): Promise<BrowserConnectOptions> => {\n  const playwrightServiceConfig = new PlaywrightServiceConfig();\n  playwrightServiceConfig.setOptions(options);\n\n  const token = await fetchOrValidateAccessToken(options?.credential);\n  return {\n    wsEndpoint: getServiceWSEndpoint(\n      playwrightServiceConfig.runId,\n      playwrightServiceConfig.serviceOs,\n    ),\n    options: {\n      headers: {\n        Authorization: `Bearer ${token}`,\n        \"x-ms-package-version\": `@azure/microsoft-playwright-testing/${getPackageVersion()}`,\n      },\n      timeout: playwrightServiceConfig.timeout,\n      exposeNetwork: playwrightServiceConfig.exposeNetwork,\n      slowMo: playwrightServiceConfig.slowMo,\n    },\n  };\n};\n\nexport { getServiceConfig, getConnectOptions };\n"]}
+{"version":3,"file":"playwrightService.js","sourceRoot":"","sources":["../../src/core/playwrightService.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;AAElC,mDAAgF;AAChF,sFAAsD;AACtD,+EAA4E;AAC5E,8FAA8D;AAE9D,0CAYwB;AACxB,iDAAkE;AAGlE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,gBAAgB,GAAG,CACvB,MAA4B,EAC5B,OAA4C,EACtB,EAAE;IACxB,IAAA,iCAAyB,GAAE,CAAC;IAC5B,IAAA,0BAAkB,GAAE,CAAC;IACrB,MAAM,qBAAqB,GAAG,IAAA,sBAAc,EAAC,IAAA,4BAAoB,GAAE,CAAC,CAAC;IACrE,MAAM,6BAA6B,GACjC,qBAAqB,CAAC,KAAK,IAAI,CAAC,IAAI,qBAAqB,CAAC,KAAK,IAAI,EAAE,CAAC;IACxE,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,EAAE,CAAC;QACxB,gCAAsB,CAAC,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC;IACjE,CAAC;IAED,uCAAuC;IACvC,+DAA+D;IAC/D,gGAAgG;IAEhG,sCAAsC;IACtC,2DAA2D;IAC3D,kGAAkG;IAClG,IAAI,MAAM,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;QACjC,IAAI,OAAO,MAAM,CAAC,WAAW,KAAK,QAAQ,EAAE,CAAC;YAC3C,IAAI,6BAA6B,EAAE,CAAC;gBAClC,wBAAc,CAAC,WAAW,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YACpD,CAAC;iBAAM,CAAC;gBACN,wBAAc,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;YAClD,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,6BAA6B,EAAE,CAAC;gBACnC,MAAM,IAAI,KAAK,CACb,uCAA4B,CAAC,4CAA4C,CAAC,OAAO,CAClF,CAAC;YACJ,CAAC;YACD,wBAAc,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QAClD,CAAC;IACH,CAAC;IAED,IAAI,MAAM,IAAI,MAAM,CAAC,cAAc,EAAE,CAAC;QACpC,IAAI,OAAO,MAAM,CAAC,cAAc,KAAK,QAAQ,EAAE,CAAC;YAC9C,IAAI,6BAA6B,EAAE,CAAC;gBAClC,wBAAc,CAAC,cAAc,GAAG,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;YAC1D,CAAC;iBAAM,CAAC;gBACN,wBAAc,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;YACxD,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,6BAA6B,EAAE,CAAC;gBACnC,MAAM,IAAI,KAAK,CACb,uCAA4B,CAAC,4CAA4C,CAAC,OAAO,CAClF,CAAC;YACJ,CAAC;YACD,wBAAc,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;QACxD,CAAC;IACH,CAAC;IAED,MAAM,uBAAuB,GAAG,IAAI,iDAAuB,EAAE,CAAC;IAC9D,uBAAuB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC5C,IAAA,wBAAgB,GAAE,CAAC;IAEnB,MAAM,eAAe,GAAQ,EAAE,CAAC;IAChC,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe,MAAK,uBAAW,CAAC,YAAY,EAAE,CAAC;QAC1D,uFAAuF;QACvF,IAAA,sBAAc,EAAC,8BAAsB,CAAC,CAAC;IACzC,CAAC;SAAM,CAAC;QACN,qIAAqI;QACrI,IAAI,6BAA6B,EAAE,CAAC;YAClC,eAAe,CAAC,WAAW,GAAG,EAAc,CAAC;YAC7C,eAAe,CAAC,cAAc,GAAG,EAAc,CAAC;YAChD,IAAI,wBAAc,CAAC,WAAW,EAAE,CAAC;gBAC/B,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,GAAI,wBAAc,CAAC,WAAwB,CAAC,CAAC;YAChF,CAAC;YACD,IAAI,wBAAc,CAAC,cAAc,EAAE,CAAC;gBAClC,eAAe,CAAC,cAAc,CAAC,IAAI,CAAC,GAAI,wBAAc,CAAC,cAA2B,CAAC,CAAC;YACtF,CAAC;YACD,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,0CAA0C,CAAC,CAAC,CAAC;YAC9F,eAAe,CAAC,cAAc,CAAC,IAAI,CACjC,OAAO,CAAC,OAAO,CAAC,6CAA6C,CAAC,CAC/D,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,uIAAuI;YACvI,eAAe,CAAC,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,0CAA0C,CAAC,CAAC;YAC1F,eAAe,CAAC,cAAc,GAAG,OAAO,CAAC,OAAO,CAC9C,6CAA6C,CAC9C,CAAC;QACJ,CAAC;IACH,CAAC;IAED,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,sBAAsB,MAAK,KAAK,EAAE,CAAC;QAC9C,yBACK,eAAe,EAClB;IACJ,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wCAA4B,CAAC,6BAA6B,CAAC,EAAE,CAAC;QAC7E,OAAO,CAAC,GAAG,CAAC,wCAA4B,CAAC,6BAA6B,CAAC,GAAG,MAAM,CAAC;QACjF,OAAO,CAAC,GAAG,CAAC,6DAA6D,CAAC,CAAC;IAC7E,CAAC;IAED,uBACE,GAAG,EAAE;YACH,cAAc,EAAE;gBACd,UAAU,EAAE,IAAA,4BAAoB,EAC9B,uBAAuB,CAAC,KAAK,EAC7B,uBAAuB,CAAC,SAAS,CAClC;gBACD,OAAO,EAAE;oBACP,aAAa,EAAE,UAAU,IAAA,sBAAc,GAAE,EAAE;oBAC3C,sBAAsB,EAAE,uCAAuC,IAAA,yBAAiB,GAAE,EAAE;iBACrF;gBACD,OAAO,EAAE,uBAAuB,CAAC,OAAO;gBACxC,aAAa,EAAE,uBAAuB,CAAC,aAAa;gBACpD,MAAM,EAAE,uBAAuB,CAAC,MAAM;aACvC;SACF,IACE,eAAe,EAClB;AACJ,CAAC,CAAC;AAsDO,4CAAgB;AApDzB;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,iBAAiB,GAAG,KAAK,EAC7B,OAAqE,EACrC,EAAE;IAClC,MAAM,uBAAuB,GAAG,IAAI,iDAAuB,EAAE,CAAC;IAC9D,uBAAuB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAE5C,MAAM,KAAK,GAAG,MAAM,IAAA,kCAA0B,EAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,CAAC,CAAC;IACpE,OAAO;QACL,UAAU,EAAE,IAAA,4BAAoB,EAC9B,uBAAuB,CAAC,KAAK,EAC7B,uBAAuB,CAAC,SAAS,CAClC;QACD,OAAO,EAAE;YACP,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,KAAK,EAAE;gBAChC,sBAAsB,EAAE,uCAAuC,IAAA,yBAAiB,GAAE,EAAE;aACrF;YACD,OAAO,EAAE,uBAAuB,CAAC,OAAO;YACxC,aAAa,EAAE,uBAAuB,CAAC,aAAa;YACpD,MAAM,EAAE,uBAAuB,CAAC,MAAM;SACvC;KACF,CAAC;AACJ,CAAC,CAAC;AAEyB,8CAAiB","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { InternalEnvironmentVariables, ServiceAuth } from \"../common/constants\";\nimport customerConfig from \"../common/customerConfig\";\nimport { PlaywrightServiceConfig } from \"../common/playwrightServiceConfig\";\nimport playwrightServiceEntra from \"./playwrightServiceEntra\";\nimport type { PlaywrightServiceAdditionalOptions, BrowserConnectOptions } from \"../common/types\";\nimport {\n  emitReportingUrl,\n  fetchOrValidateAccessToken,\n  getAccessToken,\n  getServiceWSEndpoint,\n  validateMptPAT,\n  validatePlaywrightVersion,\n  validateServiceUrl,\n  exitWithFailureMessage,\n  getPackageVersion,\n  getPlaywrightVersion,\n  getVersionInfo,\n} from \"../utils/utils\";\nimport { ServiceErrorMessageConstants } from \"../common/messages\";\nimport type { PlaywrightTestConfig } from \"@playwright/test\";\n\n/**\n * @public\n *\n * Generate playwright configuration integrated with Microsoft Playwright Testing.\n *\n * @param config - base playwright configuration\n * @param options - additional options for the service\n * @returns PlaywrightConfig\n *\n * @example\n * ```\n * import { defineConfig } from \"playwright/test\";\n * import { getServiceConfig } from \"@azure/microsoft-playwright-testing\";\n * import playwrightConfig from \"./playwright.config\";\n *\n * export default defineConfig(playwrightConfig, getServiceConfig(playwrightConfig));\n * ```\n *\n * @example\n * ```\n * import { defineConfig } from \"playwright/test\";\n * import { getServiceConfig, ServiceOS } from \"@azure/microsoft-playwright-testing\";\n * import playwrightConfig from \"./playwright.config\";\n *\n * export default defineConfig(playwrightConfig, getServiceConfig(playwrightConfig, {\n *  runId: \"custom run id\",\n *  os: ServiceOS.WINDOWS\n * }));\n * ```\n */\nconst getServiceConfig = (\n  config: PlaywrightTestConfig,\n  options?: PlaywrightServiceAdditionalOptions,\n): PlaywrightTestConfig => {\n  validatePlaywrightVersion();\n  validateServiceUrl();\n  const playwrightVersionInfo = getVersionInfo(getPlaywrightVersion());\n  const isMultipleGlobalFileSupported =\n    playwrightVersionInfo.major >= 1 && playwrightVersionInfo.minor >= 49;\n  if (options?.credential) {\n    playwrightServiceEntra.entraIdAccessToken = options.credential;\n  }\n\n  // if global setup/teardown is string -\n  // 1. if multiple global file is supported, convert it to array\n  // 2. wrap playwright-service global setup/teardown with customer provided global setup/teardown\n\n  // if global setup/teardown is array -\n  // 1. if multiple global file is not supported, throw error\n  // 2. append playwright-service global setup/teardown with customer provided global setup/teardown\n  if (config && config.globalSetup) {\n    if (typeof config.globalSetup === \"string\") {\n      if (isMultipleGlobalFileSupported) {\n        customerConfig.globalSetup = [config.globalSetup];\n      } else {\n        customerConfig.globalSetup = config.globalSetup;\n      }\n    } else {\n      if (!isMultipleGlobalFileSupported) {\n        throw new Error(\n          ServiceErrorMessageConstants.MULTIPLE_SETUP_FILE_PLAYWRIGHT_VERSION_ERROR.message,\n        );\n      }\n      customerConfig.globalSetup = config.globalSetup;\n    }\n  }\n\n  if (config && config.globalTeardown) {\n    if (typeof config.globalTeardown === \"string\") {\n      if (isMultipleGlobalFileSupported) {\n        customerConfig.globalTeardown = [config.globalTeardown];\n      } else {\n        customerConfig.globalTeardown = config.globalTeardown;\n      }\n    } else {\n      if (!isMultipleGlobalFileSupported) {\n        throw new Error(\n          ServiceErrorMessageConstants.MULTIPLE_SETUP_FILE_PLAYWRIGHT_VERSION_ERROR.message,\n        );\n      }\n      customerConfig.globalTeardown = config.globalTeardown;\n    }\n  }\n\n  const playwrightServiceConfig = new PlaywrightServiceConfig();\n  playwrightServiceConfig.setOptions(options);\n  emitReportingUrl();\n\n  const globalFunctions: any = {};\n  if (options?.serviceAuthType === ServiceAuth.ACCESS_TOKEN) {\n    // mpt PAT requested and set by the customer, no need to setup entra lifecycle handlers\n    validateMptPAT(exitWithFailureMessage);\n  } else {\n    // If multiple global file is supported, append playwright-service global setup/teardown with customer provided global setup/teardown\n    if (isMultipleGlobalFileSupported) {\n      globalFunctions.globalSetup = [] as string[];\n      globalFunctions.globalTeardown = [] as string[];\n      if (customerConfig.globalSetup) {\n        globalFunctions.globalSetup.push(...(customerConfig.globalSetup as string[]));\n      }\n      if (customerConfig.globalTeardown) {\n        globalFunctions.globalTeardown.push(...(customerConfig.globalTeardown as string[]));\n      }\n      globalFunctions.globalSetup.push(require.resolve(\"./global/playwright-service-global-setup\"));\n      globalFunctions.globalTeardown.push(\n        require.resolve(\"./global/playwright-service-global-teardown\"),\n      );\n    } else {\n      // If multiple global file is not supported, wrap playwright-service global setup/teardown with customer provided global setup/teardown\n      globalFunctions.globalSetup = require.resolve(\"./global/playwright-service-global-setup\");\n      globalFunctions.globalTeardown = require.resolve(\n        \"./global/playwright-service-global-teardown\",\n      );\n    }\n  }\n\n  if (options?.useCloudHostedBrowsers === false) {\n    return {\n      ...globalFunctions,\n    };\n  }\n  if (!process.env[InternalEnvironmentVariables.MPT_CLOUD_HOSTED_BROWSER_USED]) {\n    process.env[InternalEnvironmentVariables.MPT_CLOUD_HOSTED_BROWSER_USED] = \"true\";\n    console.log(\"\\nRunning tests using Microsoft Playwright Testing service.\");\n  }\n\n  return {\n    use: {\n      connectOptions: {\n        wsEndpoint: getServiceWSEndpoint(\n          playwrightServiceConfig.runId,\n          playwrightServiceConfig.serviceOs,\n        ),\n        headers: {\n          Authorization: `Bearer ${getAccessToken()}`,\n          \"x-ms-package-version\": `@azure/microsoft-playwright-testing/${getPackageVersion()}`,\n        },\n        timeout: playwrightServiceConfig.timeout,\n        exposeNetwork: playwrightServiceConfig.exposeNetwork,\n        slowMo: playwrightServiceConfig.slowMo,\n      },\n    },\n    ...globalFunctions,\n  };\n};\n\n/**\n * @public\n *\n * Get connect options required to connect to Microsoft Playwright Testing's cloud hosted browsers.\n *\n * @param options - additional options for the service\n * @returns BrowserConnectOptions\n *\n * @example\n * ```\n * import playwright, { test, expect, BrowserType } from \"@playwright/test\";\n * import { getConnectOptions } from \"@azure/microsoft-playwright-testing\";\n *\n * test('has title', async ({ browserName }) => {\n *  const { wsEndpoint, options } = await getConnectOptions();\n *  const browser = await (playwright[browserName] as BrowserType).connect(wsEndpoint, options);\n *  const context = await browser.newContext();\n *  const page = await context.newPage();\n *\n *  await page.goto('https://playwright.dev/');\n *  await expect(page).toHaveTitle(/Playwright/);\n *\n *  await page.close();\n *  await context.close();\n *  await browser.close();\n * });\n * ```\n */\nconst getConnectOptions = async (\n  options?: Omit<PlaywrightServiceAdditionalOptions, \"serviceAuthType\">,\n): Promise<BrowserConnectOptions> => {\n  const playwrightServiceConfig = new PlaywrightServiceConfig();\n  playwrightServiceConfig.setOptions(options);\n\n  const token = await fetchOrValidateAccessToken(options?.credential);\n  return {\n    wsEndpoint: getServiceWSEndpoint(\n      playwrightServiceConfig.runId,\n      playwrightServiceConfig.serviceOs,\n    ),\n    options: {\n      headers: {\n        Authorization: `Bearer ${token}`,\n        \"x-ms-package-version\": `@azure/microsoft-playwright-testing/${getPackageVersion()}`,\n      },\n      timeout: playwrightServiceConfig.timeout,\n      exposeNetwork: playwrightServiceConfig.exposeNetwork,\n      slowMo: playwrightServiceConfig.slowMo,\n    },\n  };\n};\n\nexport { getServiceConfig, getConnectOptions };\n"]}

package/dist/index.d.ts

@@ -4,7 +4,7 @@
  * @packageDocumentation
  */
 import { ServiceAuth, ServiceOS, ServiceEnvironmentVariable } from "./common/constants";
-import type { PlaywrightConfig, PlaywrightConfigInput, OsType, AuthenticationType, BrowserConnectOptions, MPTReporterConfig, EndpointOptions, ConnectOptions, PlaywrightServiceAdditionalOptions } from "./common/types";
+import type { OsType, AuthenticationType, BrowserConnectOptions, MPTReporterConfig, EndpointOptions, ConnectOptions, PlaywrightServiceAdditionalOptions } from "./common/types";
 import { getServiceConfig, getConnectOptions } from "./core/playwrightService";
-export { getServiceConfig, getConnectOptions, ServiceOS, ServiceAuth, ServiceEnvironmentVariable, PlaywrightConfig, PlaywrightConfigInput, OsType, AuthenticationType, BrowserConnectOptions, EndpointOptions, ConnectOptions, MPTReporterConfig, PlaywrightServiceAdditionalOptions, };
+export { getServiceConfig, getConnectOptions, ServiceOS, ServiceAuth, ServiceEnvironmentVariable, OsType, AuthenticationType, BrowserConnectOptions, EndpointOptions, ConnectOptions, MPTReporterConfig, PlaywrightServiceAdditionalOptions, };
 //# 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":"AAGA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AACxF,OAAO,KAAK,EACV,gBAAgB,EAChB,qBAAqB,EACrB,MAAM,EACN,kBAAkB,EAClB,qBAAqB,EACrB,iBAAiB,EACjB,eAAe,EACf,cAAc,EACd,kCAAkC,EACnC,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE/E,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,SAAS,EACT,WAAW,EACX,0BAA0B,EAC1B,gBAAgB,EAChB,qBAAqB,EACrB,MAAM,EACN,kBAAkB,EAClB,qBAAqB,EACrB,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,kCAAkC,GACnC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AACxF,OAAO,KAAK,EACV,MAAM,EACN,kBAAkB,EAClB,qBAAqB,EACrB,iBAAiB,EACjB,eAAe,EACf,cAAc,EACd,kCAAkC,EACnC,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE/E,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,SAAS,EACT,WAAW,EACX,0BAA0B,EAC1B,MAAM,EACN,kBAAkB,EAClB,qBAAqB,EACrB,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,kCAAkC,GACnC,CAAC"}

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * Library for integrating Microsoft Playwright Testing with existing playwright projects.\n *\n * @packageDocumentation\n */\n\nimport { ServiceAuth, ServiceOS, ServiceEnvironmentVariable } from \"./common/constants\";\nimport type {\n  PlaywrightConfig,\n  PlaywrightConfigInput,\n  OsType,\n  AuthenticationType,\n  BrowserConnectOptions,\n  MPTReporterConfig,\n  EndpointOptions,\n  ConnectOptions,\n  PlaywrightServiceAdditionalOptions,\n} from \"./common/types\";\nimport { getServiceConfig, getConnectOptions } from \"./core/playwrightService\";\n\nexport {\n  getServiceConfig,\n  getConnectOptions,\n  ServiceOS,\n  ServiceAuth,\n  ServiceEnvironmentVariable,\n  PlaywrightConfig,\n  PlaywrightConfigInput,\n  OsType,\n  AuthenticationType,\n  BrowserConnectOptions,\n  EndpointOptions,\n  ConnectOptions,\n  MPTReporterConfig,\n  PlaywrightServiceAdditionalOptions,\n};\n"],"names":[],"mappings":";;AAAA;AACA;;;AAEA;;;;AAIG;AAEH,MAAwF,WAAA,GAAA,OAAA,CAAA,oBAAA,CAAA;AAkBtF,MAAA,CAAA,cAAA,CAAA,OAAA,EAAA,aAAA,EAAA,EAAA,UAAA,EAAA,IAAA,EAAA,GAAA,EAAA,YAAA,EAAA,OAlBO,uBAAW,CAkBP,EAAA,EAAA,CAAA;AADX,MAAA,CAAA,cAAA,CAAA,OAAA,EAAA,WAAA,EAAA,EAAA,UAAA,EAAA,IAAA,EAAA,GAAA,EAAA,YAAA,EAAA,OAjBoB,qBAAS,CAiBpB,EAAA,EAAA,CAAA;AAET,MAAA,CAAA,cAAA,CAAA,OAAA,EAAA,4BAAA,EAAA,EAAA,UAAA,EAAA,IAAA,EAAA,GAAA,EAAA,YAAA,EAAA,OAnB+B,sCAA0B,CAmB/B,EAAA,EAAA,CAAA;AAP5B,MAA+E,mBAAA,GAAA,OAAA,CAAA,0BAAA,CAAA;AAG7E,MAAA,CAAA,cAAA,CAAA,OAAA,EAAA,kBAAA,EAAA,EAAA,UAAA,EAAA,IAAA,EAAA,GAAA,EAAA,YAAA,EAAA,OAHO,oCAAgB,CAGP,EAAA,EAAA,CAAA;AAChB,MAAA,CAAA,cAAA,CAAA,OAAA,EAAA,mBAAA,EAAA,EAAA,UAAA,EAAA,IAAA,EAAA,GAAA,EAAA,YAAA,EAAA,OAJyB,qCAAiB,CAIzB,EAAA,EAAA,CAAA;;"}
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * Library for integrating Microsoft Playwright Testing with existing playwright projects.\n *\n * @packageDocumentation\n */\n\nimport { ServiceAuth, ServiceOS, ServiceEnvironmentVariable } from \"./common/constants\";\nimport type {\n  OsType,\n  AuthenticationType,\n  BrowserConnectOptions,\n  MPTReporterConfig,\n  EndpointOptions,\n  ConnectOptions,\n  PlaywrightServiceAdditionalOptions,\n} from \"./common/types\";\nimport { getServiceConfig, getConnectOptions } from \"./core/playwrightService\";\n\nexport {\n  getServiceConfig,\n  getConnectOptions,\n  ServiceOS,\n  ServiceAuth,\n  ServiceEnvironmentVariable,\n  OsType,\n  AuthenticationType,\n  BrowserConnectOptions,\n  EndpointOptions,\n  ConnectOptions,\n  MPTReporterConfig,\n  PlaywrightServiceAdditionalOptions,\n};\n"],"names":[],"mappings":";;AAAA;AACA;;;AAEA;;;;AAIG;AAEH,MAAwF,WAAA,GAAA,OAAA,CAAA,oBAAA,CAAA;AAgBtF,MAAA,CAAA,cAAA,CAAA,OAAA,EAAA,aAAA,EAAA,EAAA,UAAA,EAAA,IAAA,EAAA,GAAA,EAAA,YAAA,EAAA,OAhBO,uBAAW,CAgBP,EAAA,EAAA,CAAA;AADX,MAAA,CAAA,cAAA,CAAA,OAAA,EAAA,WAAA,EAAA,EAAA,UAAA,EAAA,IAAA,EAAA,GAAA,EAAA,YAAA,EAAA,OAfoB,qBAAS,CAepB,EAAA,EAAA,CAAA;AAET,MAAA,CAAA,cAAA,CAAA,OAAA,EAAA,4BAAA,EAAA,EAAA,UAAA,EAAA,IAAA,EAAA,GAAA,EAAA,YAAA,EAAA,OAjB+B,sCAA0B,CAiB/B,EAAA,EAAA,CAAA;AAP5B,MAA+E,mBAAA,GAAA,OAAA,CAAA,0BAAA,CAAA;AAG7E,MAAA,CAAA,cAAA,CAAA,OAAA,EAAA,kBAAA,EAAA,EAAA,UAAA,EAAA,IAAA,EAAA,GAAA,EAAA,YAAA,EAAA,OAHO,oCAAgB,CAGP,EAAA,EAAA,CAAA;AAChB,MAAA,CAAA,cAAA,CAAA,OAAA,EAAA,mBAAA,EAAA,EAAA,UAAA,EAAA,IAAA,EAAA,GAAA,EAAA,YAAA,EAAA,OAJyB,qCAAiB,CAIzB,EAAA,EAAA,CAAA;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure/microsoft-playwright-testing",
-  "version": "1.0.0-alpha.20241128.1",
+  "version": "1.0.0-alpha.20241129.1",
   "description": "Package to integrate your Playwright test suite with Microsoft Playwright Testing service",
   "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/playwrighttesting/microsoft-playwright-testing/README.md",
   "sdk-type": "client",
@@ -88,6 +88,9 @@
     "sinon": "^17.0.0",
     "typescript": "~5.6.2"
   },
+  "peerDependencies": {
+    "@playwright/test": "^1.43.1"
+  },
   "prettier": "@azure/eslint-plugin-azure-sdk/prettier.json",
   "//sampleConfiguration": {
     "productName": "Microsoft Playwright Testing",

package/types/microsoft-playwright-testing.d.ts

@@ -4,6 +4,7 @@
  * @packageDocumentation
  */
 
+import type { PlaywrightTestConfig } from '@playwright/test';
 import type { TokenCredential } from '@azure/identity';
 
 /**
@@ -156,7 +157,7 @@ export declare const getConnectOptions: (options?: Omit<PlaywrightServiceAdditio
  * }));
  * ```
  */
-export declare const getServiceConfig: (config: PlaywrightConfigInput, options?: PlaywrightServiceAdditionalOptions) => PlaywrightConfig;
+export declare const getServiceConfig: (config: PlaywrightTestConfig, options?: PlaywrightServiceAdditionalOptions) => PlaywrightTestConfig;
 
 /**
  * @public
@@ -201,51 +202,6 @@ export declare interface MPTReporterConfig {
  */
 export declare type OsType = (typeof ServiceOS)[keyof typeof ServiceOS];
 
-/**
- * @public
- *
- * Playwright configuration integrated with Microsoft Playwright Testing.
- *
- * @remarks
- *
- * GlobalSetup and globalTeardown wraps around any existing global setup
- * and teardown present in the base playwright configuration and runs it.
- */
-export declare type PlaywrightConfig = {
-    use?: {
-        connectOptions: BrowserConnectOptions;
-    };
-    globalSetup?: string | string[];
-    globalTeardown?: string | string[];
-};
-
-/**
- * @public
- *
- * Base playwright configuration inputs required for generating the service config.
- */
-export declare type PlaywrightConfigInput = {
-    /**
-     * @public
-     *
-     * Path to the global setup file. This file will be required and run before all the tests. It must export a single
-     * function that takes a [`TestConfig`] argument.
-     *
-     * Learn more about {@link https://playwright.dev/docs/test-global-setup-teardown | global setup and teardown}.
-     */
-    globalSetup?: string | string[];
-    /**
-     * @public
-     *
-     * Path to the global teardown file. This file will be required and run after all the tests. It must export a single
-     * function. See also
-     * {@link https://playwright.dev/docs/api/class-testconfig#test-config-global-teardown | testConfig.globalTeardown}.
-     *
-     * Learn more about {@link https://playwright.dev/docs/test-global-setup-teardown | global setup and teardown}.
-     */
-    globalTeardown?: string | string[];
-};
-
 /**
  * @public
  *