@azure/microsoft-playwright-testing 1.0.0-alpha.20241125.1 → 1.0.0-alpha.20241127.1

package/dist/common/customerConfig.d.ts

@@ -1,7 +1,7 @@
 declare class CustomerConfig {
     private static instance;
-    globalSetup?: string;
-    globalTeardown?: string;
+    globalSetup?: string | string[];
+    globalTeardown?: string | string[];
     static getInstance(): CustomerConfig;
 }
 declare const customerConfig: CustomerConfig;

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

@@ -1 +1 @@
-{"version":3,"file":"customerConfig.d.ts","sourceRoot":"","sources":["../../src/common/customerConfig.ts"],"names":[],"mappings":"AAGA,cAAM,cAAc;IAClB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAiB;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;WAEjB,WAAW,IAAI,cAAc;CAM5C;AAED,QAAA,MAAM,cAAc,gBAA+B,CAAC;AACpD,eAAe,cAAc,CAAC"}
+{"version":3,"file":"customerConfig.d.ts","sourceRoot":"","sources":["../../src/common/customerConfig.ts"],"names":[],"mappings":"AAGA,cAAM,cAAc;IAClB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAiB;IACjC,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAChC,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;WAE5B,WAAW,IAAI,cAAc;CAM5C;AAED,QAAA,MAAM,cAAc,gBAA+B,CAAC;AACpD,eAAe,cAAc,CAAC"}

package/dist/common/customerConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"customerConfig.js","sourceRoot":"","sources":["../../src/common/customerConfig.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAElC,MAAM,cAAc;IAKX,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC;YAC7B,cAAc,CAAC,QAAQ,GAAG,IAAI,cAAc,EAAE,CAAC;QACjD,CAAC;QACD,OAAO,cAAc,CAAC,QAAQ,CAAC;IACjC,CAAC;CACF;AAED,MAAM,cAAc,GAAG,cAAc,CAAC,WAAW,EAAE,CAAC;AACpD,kBAAe,cAAc,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nclass CustomerConfig {\n  private static instance: CustomerConfig;\n  public globalSetup?: string;\n  public globalTeardown?: string;\n\n  public static getInstance(): CustomerConfig {\n    if (!CustomerConfig.instance) {\n      CustomerConfig.instance = new CustomerConfig();\n    }\n    return CustomerConfig.instance;\n  }\n}\n\nconst customerConfig = CustomerConfig.getInstance();\nexport default customerConfig;\n"]}
+{"version":3,"file":"customerConfig.js","sourceRoot":"","sources":["../../src/common/customerConfig.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAElC,MAAM,cAAc;IAKX,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC;YAC7B,cAAc,CAAC,QAAQ,GAAG,IAAI,cAAc,EAAE,CAAC;QACjD,CAAC;QACD,OAAO,cAAc,CAAC,QAAQ,CAAC;IACjC,CAAC;CACF;AAED,MAAM,cAAc,GAAG,cAAc,CAAC,WAAW,EAAE,CAAC;AACpD,kBAAe,cAAc,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nclass CustomerConfig {\n  private static instance: CustomerConfig;\n  public globalSetup?: string | string[];\n  public globalTeardown?: string | string[];\n\n  public static getInstance(): CustomerConfig {\n    if (!CustomerConfig.instance) {\n      CustomerConfig.instance = new CustomerConfig();\n    }\n    return CustomerConfig.instance;\n  }\n}\n\nconst customerConfig = CustomerConfig.getInstance();\nexport default customerConfig;\n"]}

package/dist/common/messages.d.ts

@@ -11,6 +11,10 @@ export declare const ServiceErrorMessageConstants: {
         key: string;
         message: string;
     };
+    MULTIPLE_SETUP_FILE_PLAYWRIGHT_VERSION_ERROR: {
+        key: string;
+        message: string;
+    };
     WORKSPACE_MISMATCH_ERROR: {
         key: string;
         message: string;

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

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../src/common/messages.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiCxC,CAAC"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../src/common/messages.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsCxC,CAAC"}

package/dist/common/messages.js

@@ -16,6 +16,10 @@ exports.ServiceErrorMessageConstants = {
         key: "InvalidPlaywrightVersionError",
         message: "The Playwright version you are using is not supported. See the list of supported versions at https://aka.ms/mpt/supported-versions.",
     },
+    MULTIPLE_SETUP_FILE_PLAYWRIGHT_VERSION_ERROR: {
+        key: "MultipleSetupFilePlaywrightVersionError",
+        message: "The Playwright version you are using does not support multiple setup/teardown files. Please update to Playwright version 1.49.0 or higher.",
+    },
     WORKSPACE_MISMATCH_ERROR: {
         key: "InvalidAccessToken",
         message: "The provided access token does not match the specified workspace URL. Please verify that both values are correct.",

package/dist/common/messages.js.map

@@ -1 +1 @@
-{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../src/common/messages.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAErB,QAAA,4BAA4B,GAAG;IAC1C,oBAAoB,EAAE;QACpB,GAAG,EAAE,mBAAmB;QACxB,OAAO,EACL,8GAA8G;KACjH;IACD,uBAAuB,EAAE;QACvB,GAAG,EAAE,uBAAuB;QAC5B,OAAO,EAAE,qCAAqC;KAC/C;IACD,gCAAgC,EAAE;QAChC,GAAG,EAAE,+BAA+B;QACpC,OAAO,EACL,qIAAqI;KACxI;IACD,wBAAwB,EAAE;QACxB,GAAG,EAAE,oBAAoB;QACzB,OAAO,EACL,mHAAmH;KACtH;IACD,aAAa,EAAE;QACb,GAAG,EAAE,aAAa;QAClB,OAAO,EACL,kHAAkH;KACrH;IACD,qBAAqB,EAAE;QACrB,GAAG,EAAE,oBAAoB;QACzB,OAAO,EAAE,8EAA8E;KACxF;IACD,qBAAqB,EAAE;QACrB,GAAG,EAAE,oBAAoB;QACzB,OAAO,EAAE,4DAA4D;KACtE;CACF,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport const ServiceErrorMessageConstants = {\n  NO_SERVICE_URL_ERROR: {\n    key: \"NoServiceUrlError\",\n    message:\n      \"The value for the PLAYWRIGHT_SERVICE_URL variable is not set correctly. Please verify the URL and try again.\",\n  },\n  INVALID_GLOBAL_FUNCTION: {\n    key: \"InvalidGlobalFunction\",\n    message: \"File must export a single function.\",\n  },\n  INVALID_PLAYWRIGHT_VERSION_ERROR: {\n    key: \"InvalidPlaywrightVersionError\",\n    message:\n      \"The Playwright version you are using is not supported. See the list of supported versions at https://aka.ms/mpt/supported-versions.\",\n  },\n  WORKSPACE_MISMATCH_ERROR: {\n    key: \"InvalidAccessToken\",\n    message:\n      \"The provided access token does not match the specified workspace URL. Please verify that both values are correct.\",\n  },\n  NO_AUTH_ERROR: {\n    key: \"NoAuthError\",\n    message:\n      \"Could not authenticate with the service. Please refer to https://aka.ms/mpt/authentication for more information.\",\n  },\n  INVALID_MPT_PAT_ERROR: {\n    key: \"InvalidMptPatError\",\n    message: \"The authentication token provided is invalid. Check the token and try again.\",\n  },\n  EXPIRED_MPT_PAT_ERROR: {\n    key: \"ExpiredMptPatError\",\n    message: \"Your authentication token has expired. Create a new token.\",\n  },\n};\n"]}
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../src/common/messages.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAErB,QAAA,4BAA4B,GAAG;IAC1C,oBAAoB,EAAE;QACpB,GAAG,EAAE,mBAAmB;QACxB,OAAO,EACL,8GAA8G;KACjH;IACD,uBAAuB,EAAE;QACvB,GAAG,EAAE,uBAAuB;QAC5B,OAAO,EAAE,qCAAqC;KAC/C;IACD,gCAAgC,EAAE;QAChC,GAAG,EAAE,+BAA+B;QACpC,OAAO,EACL,qIAAqI;KACxI;IACD,4CAA4C,EAAE;QAC5C,GAAG,EAAE,yCAAyC;QAC9C,OAAO,EACL,4IAA4I;KAC/I;IACD,wBAAwB,EAAE;QACxB,GAAG,EAAE,oBAAoB;QACzB,OAAO,EACL,mHAAmH;KACtH;IACD,aAAa,EAAE;QACb,GAAG,EAAE,aAAa;QAClB,OAAO,EACL,kHAAkH;KACrH;IACD,qBAAqB,EAAE;QACrB,GAAG,EAAE,oBAAoB;QACzB,OAAO,EAAE,8EAA8E;KACxF;IACD,qBAAqB,EAAE;QACrB,GAAG,EAAE,oBAAoB;QACzB,OAAO,EAAE,4DAA4D;KACtE;CACF,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport const ServiceErrorMessageConstants = {\n  NO_SERVICE_URL_ERROR: {\n    key: \"NoServiceUrlError\",\n    message:\n      \"The value for the PLAYWRIGHT_SERVICE_URL variable is not set correctly. Please verify the URL and try again.\",\n  },\n  INVALID_GLOBAL_FUNCTION: {\n    key: \"InvalidGlobalFunction\",\n    message: \"File must export a single function.\",\n  },\n  INVALID_PLAYWRIGHT_VERSION_ERROR: {\n    key: \"InvalidPlaywrightVersionError\",\n    message:\n      \"The Playwright version you are using is not supported. See the list of supported versions at https://aka.ms/mpt/supported-versions.\",\n  },\n  MULTIPLE_SETUP_FILE_PLAYWRIGHT_VERSION_ERROR: {\n    key: \"MultipleSetupFilePlaywrightVersionError\",\n    message:\n      \"The Playwright version you are using does not support multiple setup/teardown files. Please update to Playwright version 1.49.0 or higher.\",\n  },\n  WORKSPACE_MISMATCH_ERROR: {\n    key: \"InvalidAccessToken\",\n    message:\n      \"The provided access token does not match the specified workspace URL. Please verify that both values are correct.\",\n  },\n  NO_AUTH_ERROR: {\n    key: \"NoAuthError\",\n    message:\n      \"Could not authenticate with the service. Please refer to https://aka.ms/mpt/authentication for more information.\",\n  },\n  INVALID_MPT_PAT_ERROR: {\n    key: \"InvalidMptPatError\",\n    message: \"The authentication token provided is invalid. Check the token and try again.\",\n  },\n  EXPIRED_MPT_PAT_ERROR: {\n    key: \"ExpiredMptPatError\",\n    message: \"Your authentication token has expired. Create a new token.\",\n  },\n};\n"]}

package/dist/common/types.d.ts

@@ -109,7 +109,7 @@ export type PlaywrightConfigInput = {
      *
      * Learn more about {@link https://playwright.dev/docs/test-global-setup-teardown | global setup and teardown}.
      */
-    globalSetup?: string;
+    globalSetup?: string | string[];
     /**
      * @public
      *
@@ -119,7 +119,7 @@ export type PlaywrightConfigInput = {
      *
      * Learn more about {@link https://playwright.dev/docs/test-global-setup-teardown | global setup and teardown}.
      */
-    globalTeardown?: string;
+    globalTeardown?: string | string[];
 };
 /**
  * @public
@@ -135,8 +135,8 @@ export type PlaywrightConfig = {
     use?: {
         connectOptions: BrowserConnectOptions;
     };
-    globalSetup?: string;
-    globalTeardown?: string;
+    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,CAAC;IAErB;;;;;;;;OAQG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,CAAC,EAAE;QACJ,cAAc,EAAE,qBAAqB,CAAC;KACvC,CAAC;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,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"}
+{"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"}

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;\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;\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;\n  globalTeardown?: 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 * 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"]}

package/dist/core/global/playwright-service-global-setup.js

@@ -9,7 +9,10 @@ const executor_1 = require("../../common/executor");
 const customerConfig_1 = tslib_1.__importDefault(require("../../common/customerConfig"));
 const playwrightServiceGlobalSetupWrapper = async (config) => {
     const rootDir = config.configFile ? (0, path_1.dirname)(config.configFile) : process.cwd();
-    const customerGlobalSetupFunc = await (0, executor_1.loadCustomerGlobalFunction)(rootDir, customerConfig_1.default.globalSetup);
+    let customerGlobalSetupFunc = null;
+    if (customerConfig_1.default.globalSetup && typeof customerConfig_1.default.globalSetup === "string") {
+        customerGlobalSetupFunc = await (0, executor_1.loadCustomerGlobalFunction)(rootDir, customerConfig_1.default.globalSetup);
+    }
     await playwrightServiceEntra_1.default.globalSetup();
     if (customerGlobalSetupFunc) {
         return customerGlobalSetupFunc(config);

package/dist/core/global/playwright-service-global-setup.js.map

@@ -1 +1 @@
-{"version":3,"file":"playwright-service-global-setup.js","sourceRoot":"","sources":["../../../src/core/global/playwright-service-global-setup.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,+BAA+B;AAE/B,+FAA+D;AAC/D,oDAAmE;AACnE,yFAAyD;AAEzD,MAAM,mCAAmC,GAAG,KAAK,EAAE,MAAkB,EAAgB,EAAE;IACrF,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,MAAM,CAAC,UAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;IAChF,MAAM,uBAAuB,GAAG,MAAM,IAAA,qCAA0B,EAC9D,OAAO,EACP,wBAAc,CAAC,WAAW,CAC3B,CAAC;IAEF,MAAM,gCAAsB,CAAC,WAAW,EAAE,CAAC;IAC3C,IAAI,uBAAuB,EAAE,CAAC;QAC5B,OAAO,uBAAuB,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;AACH,CAAC,CAAC;AAEF,kBAAe,mCAAmC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { dirname } from \"path\";\nimport type { FullConfig } from \"../../common/types\";\nimport playwrightServiceEntra from \"../playwrightServiceEntra\";\nimport { loadCustomerGlobalFunction } from \"../../common/executor\";\nimport customerConfig from \"../../common/customerConfig\";\n\nconst playwrightServiceGlobalSetupWrapper = async (config: FullConfig): Promise<any> => {\n  const rootDir = config.configFile ? dirname(config.configFile!) : process.cwd();\n  const customerGlobalSetupFunc = await loadCustomerGlobalFunction(\n    rootDir,\n    customerConfig.globalSetup,\n  );\n\n  await playwrightServiceEntra.globalSetup();\n  if (customerGlobalSetupFunc) {\n    return customerGlobalSetupFunc(config);\n  }\n};\n\nexport default playwrightServiceGlobalSetupWrapper;\n"]}
+{"version":3,"file":"playwright-service-global-setup.js","sourceRoot":"","sources":["../../../src/core/global/playwright-service-global-setup.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,+BAA+B;AAE/B,+FAA+D;AAC/D,oDAAmE;AACnE,yFAAyD;AAEzD,MAAM,mCAAmC,GAAG,KAAK,EAAE,MAAkB,EAAgB,EAAE;IACrF,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,MAAM,CAAC,UAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;IAChF,IAAI,uBAAuB,GAAQ,IAAI,CAAC;IACxC,IAAI,wBAAc,CAAC,WAAW,IAAI,OAAO,wBAAc,CAAC,WAAW,KAAK,QAAQ,EAAE,CAAC;QACjF,uBAAuB,GAAG,MAAM,IAAA,qCAA0B,EAAC,OAAO,EAAE,wBAAc,CAAC,WAAW,CAAC,CAAC;IAClG,CAAC;IAED,MAAM,gCAAsB,CAAC,WAAW,EAAE,CAAC;IAC3C,IAAI,uBAAuB,EAAE,CAAC;QAC5B,OAAO,uBAAuB,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;AACH,CAAC,CAAC;AAEF,kBAAe,mCAAmC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { dirname } from \"path\";\nimport type { FullConfig } from \"../../common/types\";\nimport playwrightServiceEntra from \"../playwrightServiceEntra\";\nimport { loadCustomerGlobalFunction } from \"../../common/executor\";\nimport customerConfig from \"../../common/customerConfig\";\n\nconst playwrightServiceGlobalSetupWrapper = async (config: FullConfig): Promise<any> => {\n  const rootDir = config.configFile ? dirname(config.configFile!) : process.cwd();\n  let customerGlobalSetupFunc: any = null;\n  if (customerConfig.globalSetup && typeof customerConfig.globalSetup === \"string\") {\n    customerGlobalSetupFunc = await loadCustomerGlobalFunction(rootDir, customerConfig.globalSetup);\n  }\n\n  await playwrightServiceEntra.globalSetup();\n  if (customerGlobalSetupFunc) {\n    return customerGlobalSetupFunc(config);\n  }\n};\n\nexport default playwrightServiceGlobalSetupWrapper;\n"]}

package/dist/core/global/playwright-service-global-teardown.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"playwright-service-global-teardown.d.ts","sourceRoot":"","sources":["../../../src/core/global/playwright-service-global-teardown.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAKrD,QAAA,MAAM,sCAAsC,WAAkB,UAAU,KAAG,OAAO,CAAC,IAAI,CAWtF,CAAC;AAEF,eAAe,sCAAsC,CAAC"}
+{"version":3,"file":"playwright-service-global-teardown.d.ts","sourceRoot":"","sources":["../../../src/core/global/playwright-service-global-teardown.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAKrD,QAAA,MAAM,sCAAsC,WAAkB,UAAU,KAAG,OAAO,CAAC,IAAI,CActF,CAAC;AAEF,eAAe,sCAAsC,CAAC"}

package/dist/core/global/playwright-service-global-teardown.js

@@ -9,7 +9,10 @@ const executor_1 = require("../../common/executor");
 const customerConfig_1 = tslib_1.__importDefault(require("../../common/customerConfig"));
 const playwrightServiceGlobalTeardownWrapper = async (config) => {
     const rootDir = config.configFile ? (0, path_1.dirname)(config.configFile) : process.cwd();
-    const customerGlobalTeardownFunc = await (0, executor_1.loadCustomerGlobalFunction)(rootDir, customerConfig_1.default.globalTeardown);
+    let customerGlobalTeardownFunc = null;
+    if (customerConfig_1.default.globalTeardown && typeof customerConfig_1.default.globalTeardown === "string") {
+        customerGlobalTeardownFunc = await (0, executor_1.loadCustomerGlobalFunction)(rootDir, customerConfig_1.default.globalTeardown);
+    }
     playwrightServiceEntra_1.default.globalTeardown();
     if (customerGlobalTeardownFunc) {
         await customerGlobalTeardownFunc(config);

package/dist/core/global/playwright-service-global-teardown.js.map

@@ -1 +1 @@
-{"version":3,"file":"playwright-service-global-teardown.js","sourceRoot":"","sources":["../../../src/core/global/playwright-service-global-teardown.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,+BAA+B;AAE/B,+FAA+D;AAC/D,oDAAmE;AACnE,yFAAyD;AAEzD,MAAM,sCAAsC,GAAG,KAAK,EAAE,MAAkB,EAAiB,EAAE;IACzF,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,MAAM,CAAC,UAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;IAChF,MAAM,0BAA0B,GAAG,MAAM,IAAA,qCAA0B,EACjE,OAAO,EACP,wBAAc,CAAC,cAAc,CAC9B,CAAC;IAEF,gCAAsB,CAAC,cAAc,EAAE,CAAC;IACxC,IAAI,0BAA0B,EAAE,CAAC;QAC/B,MAAM,0BAA0B,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;AACH,CAAC,CAAC;AAEF,kBAAe,sCAAsC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { dirname } from \"path\";\nimport type { FullConfig } from \"../../common/types\";\nimport playwrightServiceEntra from \"../playwrightServiceEntra\";\nimport { loadCustomerGlobalFunction } from \"../../common/executor\";\nimport customerConfig from \"../../common/customerConfig\";\n\nconst playwrightServiceGlobalTeardownWrapper = async (config: FullConfig): Promise<void> => {\n  const rootDir = config.configFile ? dirname(config.configFile!) : process.cwd();\n  const customerGlobalTeardownFunc = await loadCustomerGlobalFunction(\n    rootDir,\n    customerConfig.globalTeardown,\n  );\n\n  playwrightServiceEntra.globalTeardown();\n  if (customerGlobalTeardownFunc) {\n    await customerGlobalTeardownFunc(config);\n  }\n};\n\nexport default playwrightServiceGlobalTeardownWrapper;\n"]}
+{"version":3,"file":"playwright-service-global-teardown.js","sourceRoot":"","sources":["../../../src/core/global/playwright-service-global-teardown.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,+BAA+B;AAE/B,+FAA+D;AAC/D,oDAAmE;AACnE,yFAAyD;AAEzD,MAAM,sCAAsC,GAAG,KAAK,EAAE,MAAkB,EAAiB,EAAE;IACzF,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,MAAM,CAAC,UAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;IAChF,IAAI,0BAA0B,GAAQ,IAAI,CAAC;IAC3C,IAAI,wBAAc,CAAC,cAAc,IAAI,OAAO,wBAAc,CAAC,cAAc,KAAK,QAAQ,EAAE,CAAC;QACvF,0BAA0B,GAAG,MAAM,IAAA,qCAA0B,EAC3D,OAAO,EACP,wBAAc,CAAC,cAAc,CAC9B,CAAC;IACJ,CAAC;IAED,gCAAsB,CAAC,cAAc,EAAE,CAAC;IACxC,IAAI,0BAA0B,EAAE,CAAC;QAC/B,MAAM,0BAA0B,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;AACH,CAAC,CAAC;AAEF,kBAAe,sCAAsC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { dirname } from \"path\";\nimport type { FullConfig } from \"../../common/types\";\nimport playwrightServiceEntra from \"../playwrightServiceEntra\";\nimport { loadCustomerGlobalFunction } from \"../../common/executor\";\nimport customerConfig from \"../../common/customerConfig\";\n\nconst playwrightServiceGlobalTeardownWrapper = async (config: FullConfig): Promise<void> => {\n  const rootDir = config.configFile ? dirname(config.configFile!) : process.cwd();\n  let customerGlobalTeardownFunc: any = null;\n  if (customerConfig.globalTeardown && typeof customerConfig.globalTeardown === \"string\") {\n    customerGlobalTeardownFunc = await loadCustomerGlobalFunction(\n      rootDir,\n      customerConfig.globalTeardown,\n    );\n  }\n\n  playwrightServiceEntra.globalTeardown();\n  if (customerGlobalTeardownFunc) {\n    await customerGlobalTeardownFunc(config);\n  }\n};\n\nexport default playwrightServiceGlobalTeardownWrapper;\n"]}

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;AAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,QAAA,MAAM,gBAAgB,WACZ,qBAAqB,YACnB,kCAAkC,KAC3C,gBAsDF,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,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"}

package/dist/core/playwrightService.js

@@ -9,6 +9,7 @@ const customerConfig_1 = tslib_1.__importDefault(require("../common/customerConf
 const playwrightServiceConfig_1 = require("../common/playwrightServiceConfig");
 const playwrightServiceEntra_1 = tslib_1.__importDefault(require("./playwrightServiceEntra"));
 const utils_1 = require("../utils/utils");
+const messages_1 = require("../common/messages");
 /**
  * @public
  *
@@ -42,14 +43,48 @@ const utils_1 = require("../utils/utils");
 const getServiceConfig = (config, options) => {
     (0, utils_1.validatePlaywrightVersion)();
     (0, utils_1.validateServiceUrl)();
+    const playwrightVersionInfo = (0, utils_1.getVersionInfo)((0, utils_1.getPlaywrightVersion)());
+    const isMultipleGlobalFileSupported = playwrightVersionInfo.major >= 1 && playwrightVersionInfo.minor >= 49;
     if (options === null || options === void 0 ? void 0 : options.credential) {
         playwrightServiceEntra_1.default.entraIdAccessToken = options.credential;
     }
-    if (config.globalSetup) {
-        customerConfig_1.default.globalSetup = config.globalSetup;
+    // if global setup/teardown is string -
+    // 1. if multiple global file is supported, convert it to array
+    // 2. wrap playwright-service global setup/teardown with customer provided global setup/teardown
+    // if global setup/teardown is array -
+    // 1. if multiple global file is not supported, throw error
+    // 2. append playwright-service global setup/teardown with customer provided global setup/teardown
+    if (config && config.globalSetup) {
+        if (typeof config.globalSetup === "string") {
+            if (isMultipleGlobalFileSupported) {
+                customerConfig_1.default.globalSetup = [config.globalSetup];
+            }
+            else {
+                customerConfig_1.default.globalSetup = config.globalSetup;
+            }
+        }
+        else {
+            if (!isMultipleGlobalFileSupported) {
+                throw new Error(messages_1.ServiceErrorMessageConstants.MULTIPLE_SETUP_FILE_PLAYWRIGHT_VERSION_ERROR.message);
+            }
+            customerConfig_1.default.globalSetup = config.globalSetup;
+        }
     }
-    if (config.globalTeardown) {
-        customerConfig_1.default.globalTeardown = config.globalTeardown;
+    if (config && config.globalTeardown) {
+        if (typeof config.globalTeardown === "string") {
+            if (isMultipleGlobalFileSupported) {
+                customerConfig_1.default.globalTeardown = [config.globalTeardown];
+            }
+            else {
+                customerConfig_1.default.globalTeardown = config.globalTeardown;
+            }
+        }
+        else {
+            if (!isMultipleGlobalFileSupported) {
+                throw new Error(messages_1.ServiceErrorMessageConstants.MULTIPLE_SETUP_FILE_PLAYWRIGHT_VERSION_ERROR.message);
+            }
+            customerConfig_1.default.globalTeardown = config.globalTeardown;
+        }
     }
     const playwrightServiceConfig = new playwrightServiceConfig_1.PlaywrightServiceConfig();
     playwrightServiceConfig.setOptions(options);
@@ -60,8 +95,24 @@ const getServiceConfig = (config, options) => {
         (0, utils_1.validateMptPAT)(utils_1.exitWithFailureMessage);
     }
     else {
-        globalFunctions.globalSetup = require.resolve("./global/playwright-service-global-setup");
-        globalFunctions.globalTeardown = require.resolve("./global/playwright-service-global-teardown");
+        // If multiple global file is supported, append playwright-service global setup/teardown with customer provided global setup/teardown
+        if (isMultipleGlobalFileSupported) {
+            globalFunctions.globalSetup = [];
+            globalFunctions.globalTeardown = [];
+            if (customerConfig_1.default.globalSetup) {
+                globalFunctions.globalSetup.push(...customerConfig_1.default.globalSetup);
+            }
+            if (customerConfig_1.default.globalTeardown) {
+                globalFunctions.globalTeardown.push(...customerConfig_1.default.globalTeardown);
+            }
+            globalFunctions.globalSetup.push(require.resolve("./global/playwright-service-global-setup"));
+            globalFunctions.globalTeardown.push(require.resolve("./global/playwright-service-global-teardown"));
+        }
+        else {
+            // If multiple global file is not supported, wrap playwright-service global setup/teardown with customer provided global setup/teardown
+            globalFunctions.globalSetup = require.resolve("./global/playwright-service-global-setup");
+            globalFunctions.globalTeardown = require.resolve("./global/playwright-service-global-teardown");
+        }
     }
     if ((options === null || options === void 0 ? void 0 : options.useCloudHostedBrowsers) === false) {
         return Object.assign({}, globalFunctions);

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,0CAUwB;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,gBAAgB,GAAG,CACvB,MAA6B,EAC7B,OAA4C,EAC1B,EAAE;IACpB,IAAA,iCAAyB,GAAE,CAAC;IAC5B,IAAA,0BAAkB,GAAE,CAAC;IACrB,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,EAAE,CAAC;QACxB,gCAAsB,CAAC,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC;IACjE,CAAC;IACD,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;QACvB,wBAAc,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;IAClD,CAAC;IACD,IAAI,MAAM,CAAC,cAAc,EAAE,CAAC;QAC1B,wBAAc,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;IACxD,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,eAAe,CAAC,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,0CAA0C,CAAC,CAAC;QAC1F,eAAe,CAAC,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,6CAA6C,CAAC,CAAC;IAClG,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} from \"../utils/utils\";\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  if (options?.credential) {\n    playwrightServiceEntra.entraIdAccessToken = options.credential;\n  }\n  if (config.globalSetup) {\n    customerConfig.globalSetup = config.globalSetup;\n  }\n  if (config.globalTeardown) {\n    customerConfig.globalTeardown = config.globalTeardown;\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    globalFunctions.globalSetup = require.resolve(\"./global/playwright-service-global-setup\");\n    globalFunctions.globalTeardown = require.resolve(\"./global/playwright-service-global-teardown\");\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;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"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure/microsoft-playwright-testing",
-  "version": "1.0.0-alpha.20241125.1",
+  "version": "1.0.0-alpha.20241127.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",

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

@@ -1,114 +1,162 @@
 /**
- * Microsoft Playwright Testing's Reporting
- * feature to publish test results and related artifacts and
- * view them in the service portal for faster and easier troubleshooting.
+ * Library for integrating Microsoft Playwright Testing with existing playwright projects.
  *
  * @packageDocumentation
  */
 
-import type { FullConfig } from '@playwright/test/reporter';
-import type { FullResult } from '@playwright/test/reporter';
-import type { Reporter } from '@playwright/test/reporter';
-import type { Suite } from '@playwright/test/reporter';
-import type { TestCase } from '@playwright/test/reporter';
-import type { TestResult } from '@playwright/test/reporter';
+import type { TokenCredential } from '@azure/identity';
 
 /**
  * @public
  *
- * Extends Playwright's Reporter class to enable Microsoft Playwright Testing's Reporting
- * feature to publish test results and related artifacts and
- * view them in the service portal for faster and easier troubleshooting.
+ * Authentication types supported by Microsoft Playwright Testing.
+ */
+export declare type AuthenticationType = (typeof ServiceAuth)[keyof typeof ServiceAuth];
+
+/**
+ * @public
  *
- * @example
+ * Browser connect options for the service. This includes endpoint options and connect options.
  *
+ * @example
  * ```
- * import { defineConfig } from "@playwright/test";
+ * import playwright, { test, expect, BrowserType } from "@playwright/test";
+ * import { getConnectOptions, BrowserConnectOptions } from "@azure/microsoft-playwright-testing";
  *
- * export default defineConfig({
- *  reporter: [["@azure/microsoft-playwright-testing/reporter"]]
+ * test("has title", async ({ browserName }) => {
+ *  const { wsEndpoint, options } : BrowserConnectOptions = await getConnectOptions();
+ *  const browser = await (playwright[browserName] as BrowserType).connect(wsEndpoint, options);
+ *  const context = await browser.newContext();
+ *  const page = await context.newPage();
+ *
+ *  await page.goto("https://playwright.dev/");
+ *  await expect(page).toHaveTitle(/Playwright/);
+ *
+ *  await page.close();
+ *  await context.close();
+ *  await browser.close();
  * });
  * ```
  */
-declare class MPTReporter implements Reporter {
-    private isTokenValid;
-    private enableGitHubSummary;
-    private isRegionValid;
-    private shard;
-    private isTestRunStartSuccess;
-    private ciInfo;
-    private serviceClient;
-    private storageClient;
-    private reporterUtils;
-    private envVariables;
-    private testRawResults;
-    private promiseOnBegin;
-    private _testEndPromises;
-    private testResultBatch;
-    private errorMessages;
-    private informationalMessages;
-    private processedErrorMessageKeys;
-    private sasUri;
-    private uploadMetadata;
-    private numWorkers;
-    private testRunUrl;
-    private enableResultPublish;
-    constructor(config: Partial<MPTReporterConfig>);
-    private _addError;
-    private _addInformationalMessage;
-    private _addKeyToInformationMessage;
-    private _isInformationMessagePresent;
-    private _reporterFailureHandler;
+export declare type BrowserConnectOptions = EndpointOptions & {
+    options: ConnectOptions;
+};
+
+/**
+ * @public
+ *
+ * Connect options for the service.
+ */
+export declare type ConnectOptions = {
+    /**
+     * @public
+     *
+     * Additional HTTP headers to be sent with web socket connect request.
+     */
+    headers?: {
+        [key: string]: string;
+    };
     /**
      * @public
      *
-     * Called once before running tests.
+     * Exposes network available on the connecting client to the browser being connected to.
      *
-     * @param config - Resolved configuration.
-     * @param suite - The root suite that contains all projects, files and test cases.
+     * @defaultValue `<loopback>`
      */
-    onBegin(config: FullConfig, suite: Suite): void;
+    exposeNetwork?: string;
     /**
      * @public
      *
-     * Called after a test has been finished in the worker process.
+     * Maximum time in milliseconds to wait for the connection to be established.
      *
-     * @param test - Test that has been finished.
-     * @param result - Result of the test run.
+     * @defaultValue `30000`
      */
-    onTestEnd(test: TestCase, result: TestResult): void;
+    timeout?: number;
     /**
      * @public
      *
-     * Called after all tests have been run, or testing has been interrupted. Note that this method may return a [Promise]
-     * and Playwright Test will await it. Reporter is allowed to override the status and hence affect the exit code of the
-     * test runner.
+     * Slows down Playwright operations by the specified amount of milliseconds.
      *
-     * @param result - Result of the full test run, `status` can be one of:
-     * - `'passed'` - Everything went as expected.
-     * - `'failed'` - Any test has failed.
-     * - `'timedout'` - The
-     * {@link https://playwright.dev/docs/api/class-testconfig#test-config-global-timeout | testConfig.globalTimeout} has
-     * been reached.
-     * - `'interrupted'` - Interrupted by the user.
+     * @defaultValue `0`
      */
-    onEnd(result: FullResult): Promise<void>;
-    private _onBegin;
-    private _onTestEnd;
-    private _onEnd;
-    private _uploadTestResultAttachments;
-    private initializeMPTReporter;
-    private displayAdditionalInformation;
-    private processTestResult;
+    slowMo?: number;
+};
+
+/**
+ * @public
+ *
+ * Endpoint options for the service.
+ */
+export declare type EndpointOptions = {
     /**
      * @public
      *
-     * Whether this reporter uses stdio for reporting. When it does not, Playwright Test could add some output to enhance
-     * user experience. If your reporter does not print to the terminal, it is strongly recommended to return `false`.
+     * A browser websocket endpoint to connect to.
      */
-    printsToStdio(): boolean;
-}
-export default MPTReporter;
+    wsEndpoint: string;
+};
+
+/**
+ * @public
+ *
+ * Get connect options required to connect to Microsoft Playwright Testing's cloud hosted browsers.
+ *
+ * @param options - additional options for the service
+ * @returns BrowserConnectOptions
+ *
+ * @example
+ * ```
+ * import playwright, { test, expect, BrowserType } from "@playwright/test";
+ * import { getConnectOptions } from "@azure/microsoft-playwright-testing";
+ *
+ * test('has title', async ({ browserName }) => {
+ *  const { wsEndpoint, options } = await getConnectOptions();
+ *  const browser = await (playwright[browserName] as BrowserType).connect(wsEndpoint, options);
+ *  const context = await browser.newContext();
+ *  const page = await context.newPage();
+ *
+ *  await page.goto('https://playwright.dev/');
+ *  await expect(page).toHaveTitle(/Playwright/);
+ *
+ *  await page.close();
+ *  await context.close();
+ *  await browser.close();
+ * });
+ * ```
+ */
+export declare const getConnectOptions: (options?: Omit<PlaywrightServiceAdditionalOptions, "serviceAuthType">) => Promise<BrowserConnectOptions>;
+
+/**
+ * @public
+ *
+ * Generate playwright configuration integrated with Microsoft Playwright Testing.
+ *
+ * @param config - base playwright configuration
+ * @param options - additional options for the service
+ * @returns PlaywrightConfig
+ *
+ * @example
+ * ```
+ * import { defineConfig } from "playwright/test";
+ * import { getServiceConfig } from "@azure/microsoft-playwright-testing";
+ * import playwrightConfig from "./playwright.config";
+ *
+ * export default defineConfig(playwrightConfig, getServiceConfig(playwrightConfig));
+ * ```
+ *
+ * @example
+ * ```
+ * import { defineConfig } from "playwright/test";
+ * import { getServiceConfig, ServiceOS } from "@azure/microsoft-playwright-testing";
+ * import playwrightConfig from "./playwright.config";
+ *
+ * export default defineConfig(playwrightConfig, getServiceConfig(playwrightConfig, {
+ *  runId: "custom run id",
+ *  os: ServiceOS.WINDOWS
+ * }));
+ * ```
+ */
+export declare const getServiceConfig: (config: PlaywrightConfigInput, options?: PlaywrightServiceAdditionalOptions) => PlaywrightConfig;
 
 /**
  * @public
@@ -127,7 +175,7 @@ export default MPTReporter;
  * });
  * ```
  */
-declare interface MPTReporterConfig {
+export declare interface MPTReporterConfig {
     /**
      * @public
      *
@@ -146,4 +194,166 @@ declare interface MPTReporterConfig {
     enableResultPublish?: boolean;
 }
 
+/**
+ * @public
+ *
+ * OS Types supported by Microsoft Playwright Testing.
+ */
+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
+ *
+ * Additional options for the service.
+ */
+export declare type PlaywrightServiceAdditionalOptions = {
+    /**
+     * @public
+     *
+     * Authentication types supported by Microsoft Playwright Testing.
+     *
+     * @defaultValue  `ENTRA_ID`
+     */
+    serviceAuthType?: AuthenticationType;
+    /**
+     * @public
+     *
+     * Operating system types supported by Microsoft Playwright Testing.
+     *
+     * @defaultValue  `linux`
+     */
+    os?: OsType;
+    /**
+     * @public
+     *
+     * Run id for the test run.
+     *
+     * @defaultValue `current datetime as ISO string`
+     */
+    runId?: string;
+    /**
+     * @public
+     *
+     * Maximum time in milliseconds to wait for the connection to be established.
+     *
+     * @defaultValue `30000`
+     */
+    timeout?: number;
+    /**
+     * @public
+     *
+     * Slows down Playwright operations by the specified amount of milliseconds.
+     *
+     * @defaultValue `0`
+     */
+    slowMo?: number;
+    /**
+     * @public
+     *
+     * Exposes network available on the connecting client to the browser being connected to.
+     *
+     * @defaultValue `<loopback>`
+     */
+    exposeNetwork?: string;
+    /**
+     * @public
+     *
+     * Use cloud hosted browsers.
+     *
+     * @defaultValue `false`
+     */
+    useCloudHostedBrowsers?: boolean;
+    /**
+     * @public
+     *
+     * 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}.
+     *
+     * @defaultValue `DefaultAzureCredential`
+     */
+    credential?: TokenCredential;
+    /**
+     * @public
+     *
+     * Run name for the test run.
+     *
+     * @defaultValue `guid`
+     */
+    runName?: string;
+};
+
+/** @public
+ *
+ * Authentication types supported on Microsoft Playwright Testing
+ */
+export declare const ServiceAuth: {
+    readonly ENTRA_ID: "ENTRA_ID";
+    readonly ACCESS_TOKEN: "ACCESS_TOKEN";
+};
+
+/** @public
+ *
+ * Environment variables used by Microsoft Playwright Testing
+ */
+export declare const ServiceEnvironmentVariable: {
+    PLAYWRIGHT_SERVICE_OS: string;
+    PLAYWRIGHT_SERVICE_EXPOSE_NETWORK_ENVIRONMENT_VARIABLE: string;
+    PLAYWRIGHT_SERVICE_ACCESS_TOKEN: string;
+    PLAYWRIGHT_SERVICE_URL: string;
+    PLAYWRIGHT_SERVICE_REPORTING_URL: string;
+};
+
+/** @public
+ *
+ * OS types supported on Microsoft Playwright Testing cloud hosted browsers
+ */
+export declare const ServiceOS: {
+    readonly LINUX: "linux";
+    readonly WINDOWS: "windows";
+};
+
 export { }

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

@@ -0,0 +1,149 @@
+/**
+ * Microsoft Playwright Testing's Reporting
+ * feature to publish test results and related artifacts and
+ * view them in the service portal for faster and easier troubleshooting.
+ *
+ * @packageDocumentation
+ */
+
+import type { FullConfig } from '@playwright/test/reporter';
+import type { FullResult } from '@playwright/test/reporter';
+import type { Reporter } from '@playwright/test/reporter';
+import type { Suite } from '@playwright/test/reporter';
+import type { TestCase } from '@playwright/test/reporter';
+import type { TestResult } from '@playwright/test/reporter';
+
+/**
+ * @public
+ *
+ * Extends Playwright's Reporter class to enable Microsoft Playwright Testing's Reporting
+ * feature to publish test results and related artifacts and
+ * view them in the service portal for faster and easier troubleshooting.
+ *
+ * @example
+ *
+ * ```
+ * import { defineConfig } from "@playwright/test";
+ *
+ * export default defineConfig({
+ *  reporter: [["@azure/microsoft-playwright-testing/reporter"]]
+ * });
+ * ```
+ */
+declare class MPTReporter implements Reporter {
+    private isTokenValid;
+    private enableGitHubSummary;
+    private isRegionValid;
+    private shard;
+    private isTestRunStartSuccess;
+    private ciInfo;
+    private serviceClient;
+    private storageClient;
+    private reporterUtils;
+    private envVariables;
+    private testRawResults;
+    private promiseOnBegin;
+    private _testEndPromises;
+    private testResultBatch;
+    private errorMessages;
+    private informationalMessages;
+    private processedErrorMessageKeys;
+    private sasUri;
+    private uploadMetadata;
+    private numWorkers;
+    private testRunUrl;
+    private enableResultPublish;
+    constructor(config: Partial<MPTReporterConfig>);
+    private _addError;
+    private _addInformationalMessage;
+    private _addKeyToInformationMessage;
+    private _isInformationMessagePresent;
+    private _reporterFailureHandler;
+    /**
+     * @public
+     *
+     * Called once before running tests.
+     *
+     * @param config - Resolved configuration.
+     * @param suite - The root suite that contains all projects, files and test cases.
+     */
+    onBegin(config: FullConfig, suite: Suite): void;
+    /**
+     * @public
+     *
+     * Called after a test has been finished in the worker process.
+     *
+     * @param test - Test that has been finished.
+     * @param result - Result of the test run.
+     */
+    onTestEnd(test: TestCase, result: TestResult): void;
+    /**
+     * @public
+     *
+     * Called after all tests have been run, or testing has been interrupted. Note that this method may return a [Promise]
+     * and Playwright Test will await it. Reporter is allowed to override the status and hence affect the exit code of the
+     * test runner.
+     *
+     * @param result - Result of the full test run, `status` can be one of:
+     * - `'passed'` - Everything went as expected.
+     * - `'failed'` - Any test has failed.
+     * - `'timedout'` - The
+     * {@link https://playwright.dev/docs/api/class-testconfig#test-config-global-timeout | testConfig.globalTimeout} has
+     * been reached.
+     * - `'interrupted'` - Interrupted by the user.
+     */
+    onEnd(result: FullResult): Promise<void>;
+    private _onBegin;
+    private _onTestEnd;
+    private _onEnd;
+    private _uploadTestResultAttachments;
+    private initializeMPTReporter;
+    private displayAdditionalInformation;
+    private processTestResult;
+    /**
+     * @public
+     *
+     * Whether this reporter uses stdio for reporting. When it does not, Playwright Test could add some output to enhance
+     * user experience. If your reporter does not print to the terminal, it is strongly recommended to return `false`.
+     */
+    printsToStdio(): boolean;
+}
+export default MPTReporter;
+
+/**
+ * @public
+ *
+ * Optional configuration for MPT Reporter.
+ *
+ * @example
+ *
+ * ```
+ * import { defineConfig } from "@playwright/test";
+ *
+ * export default defineConfig({
+ *  reporter: [["@azure/microsoft-playwright-testing/reporter", {
+ *   enableGitHubSummary: true
+ *  }]],
+ * });
+ * ```
+ */
+declare interface MPTReporterConfig {
+    /**
+     * @public
+     *
+     * Enable GitHub Actions annotations to diagnose test failures and deep link to MPT Portal.
+     *
+     * @defaultValue `true`
+     */
+    enableGitHubSummary?: boolean;
+    /**
+     * @public
+     *
+     * Enable result publishing for the test run. This will upload the test result and artifacts to the MPT Portal.
+     *
+     * @defaultValue `true`
+     */
+    enableResultPublish?: boolean;
+}
+
+export { }