@stablyai/playwright-test 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,22 @@
+# Stably Playwright Test
+This package extends Playwright to add new AI functionality
+
+## Installation
+First ensure you remove any previous playwright/playwright-test installation
+```shell
+npm remove playwright @playwright/test
+```
+
+Afterwards you can install Stably
+```shell
+npm install @stablyai/playwright-test
+```
+
+## Setup
+Make sure you also get your [api-key](https://auth.stably.ai/account/api_keys) to use the AI features.
+Either set the `process.env.STABLY_API_KEY` variable or programtically call `setApiKey` from `"@stablyai/playwright-test"`
+
+## Usage
+1. Replace "@playwright/test" with "@stablyai/playwright-test"
+   1. Ex: imports should look like: import { test, expect } from "@stablyai/playwright-test";
+2. Simply run tests with `npx playwright test` as you would normally using Playwright

package/cli.js

@@ -0,0 +1,2 @@
+const { program } = require("@stablyai/internal-playwright-test");
+program.parse(process.argv);

package/dist/index.d.mts

@@ -1,23 +1,23 @@
 import "@stablyai/playwright-base";
 import * as _stablyai_playwright_base from '@stablyai/playwright-base';
 export { setApiKey } from '@stablyai/playwright-base';
-import * as _playwright_test from '@playwright/test';
-import { test as test$1 } from '@playwright/test';
-export * from '@playwright/test';
+import * as _stablyai_internal_playwright_test from '@stablyai/internal-playwright-test';
+import { test as test$1 } from '@stablyai/internal-playwright-test';
+export * from '@stablyai/internal-playwright-test';
 
 declare const test: typeof test$1;
-declare const expect: _playwright_test.Expect<{
+declare const expect: _stablyai_internal_playwright_test.Expect<{
     readonly toMatchScreenshotPrompt: (this: {
         isNot: boolean;
         message?: () => string;
-    }, received: _playwright_test.Page | _playwright_test.Locator, condition: string, options?: _stablyai_playwright_base.ScreenshotPromptOptions) => Promise<{
+    }, received: _stablyai_internal_playwright_test.Page | _stablyai_internal_playwright_test.Locator, condition: string, options?: _stablyai_playwright_base.ScreenshotPromptOptions) => Promise<{
         pass: boolean;
         message: () => string;
     }>;
 }>;
 
-declare module '@playwright/test' {
-    type ScreenshotPromptOptions = _playwright_test.PageAssertionsToHaveScreenshotOptions;
+declare module "@stablyai/internal-playwright-test" {
+    type ScreenshotPromptOptions = _stablyai_internal_playwright_test.PageAssertionsToHaveScreenshotOptions;
     interface LocatorAssertions {
         toMatchScreenshotPrompt(condition: string, options?: ScreenshotPromptOptions): Promise<void>;
     }

package/dist/index.d.ts

@@ -1,23 +1,23 @@
 import "@stablyai/playwright-base";
 import * as _stablyai_playwright_base from '@stablyai/playwright-base';
 export { setApiKey } from '@stablyai/playwright-base';
-import * as _playwright_test from '@playwright/test';
-import { test as test$1 } from '@playwright/test';
-export * from '@playwright/test';
+import * as _stablyai_internal_playwright_test from '@stablyai/internal-playwright-test';
+import { test as test$1 } from '@stablyai/internal-playwright-test';
+export * from '@stablyai/internal-playwright-test';
 
 declare const test: typeof test$1;
-declare const expect: _playwright_test.Expect<{
+declare const expect: _stablyai_internal_playwright_test.Expect<{
     readonly toMatchScreenshotPrompt: (this: {
         isNot: boolean;
         message?: () => string;
-    }, received: _playwright_test.Page | _playwright_test.Locator, condition: string, options?: _stablyai_playwright_base.ScreenshotPromptOptions) => Promise<{
+    }, received: _stablyai_internal_playwright_test.Page | _stablyai_internal_playwright_test.Locator, condition: string, options?: _stablyai_playwright_base.ScreenshotPromptOptions) => Promise<{
         pass: boolean;
         message: () => string;
     }>;
 }>;
 
-declare module '@playwright/test' {
-    type ScreenshotPromptOptions = _playwright_test.PageAssertionsToHaveScreenshotOptions;
+declare module "@stablyai/internal-playwright-test" {
+    type ScreenshotPromptOptions = _stablyai_internal_playwright_test.PageAssertionsToHaveScreenshotOptions;
     interface LocatorAssertions {
         toMatchScreenshotPrompt(condition: string, options?: ScreenshotPromptOptions): Promise<void>;
     }

package/dist/index.js

@@ -27,11 +27,11 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 var import_playwright_base = require("@stablyai/playwright-base");
-var import_test = require("@playwright/test");
+var import_internal_playwright_test = require("@stablyai/internal-playwright-test");
 var import_playwright_base2 = require("@stablyai/playwright-base");
 var import_playwright_base3 = require("@stablyai/playwright-base");
-__reExport(index_exports, require("@playwright/test"), module.exports);
-var test = import_test.test.extend({
+__reExport(index_exports, require("@stablyai/internal-playwright-test"), module.exports);
+var test = import_internal_playwright_test.test.extend({
   browser: async ({ browser }, use) => {
     await use((0, import_playwright_base2.augmentBrowser)(browser));
   },
@@ -42,12 +42,12 @@ var test = import_test.test.extend({
     await use((0, import_playwright_base2.augmentPage)(page));
   }
 });
-var expect = import_test.expect.extend(import_playwright_base2.stablyPlaywrightMatchers);
+var expect = import_internal_playwright_test.expect.extend(import_playwright_base2.stablyPlaywrightMatchers);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   expect,
   setApiKey,
   test,
-  ...require("@playwright/test")
+  ...require("@stablyai/internal-playwright-test")
 });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import '@stablyai/playwright-base';\n\nimport {\n  expect as playwrightExpect,\n  test as playwrightTest,\n} from '@playwright/test';\n\nimport {\n  augmentBrowser,\n  augmentBrowserContext,\n  augmentPage,\n  stablyPlaywrightMatchers,\n} from '@stablyai/playwright-base';\n\nexport { setApiKey } from '@stablyai/playwright-base';\n\nexport const test: typeof playwrightTest = playwrightTest.extend({\n  browser: async ({ browser }, use) => {\n    await use(augmentBrowser(browser));\n  },\n  context: async ({ context }, use) => {\n    await use(augmentBrowserContext(context));\n  },\n  page: async ({ page }, use) => {\n    await use(augmentPage(page));\n  },\n});\n\nexport const expect = playwrightExpect.extend(stablyPlaywrightMatchers);\n\nexport * from '@playwright/test';\n\ndeclare module '@playwright/test' {\n  export type ScreenshotPromptOptions =\n    import('@playwright/test').PageAssertionsToHaveScreenshotOptions;\n\n  interface LocatorAssertions {\n    toMatchScreenshotPrompt(\n      condition: string,\n      options?: ScreenshotPromptOptions,\n    ): Promise<void>;\n  }\n\n  interface PageAssertions {\n    toMatchScreenshotPrompt(\n      condition: string,\n      options?: ScreenshotPromptOptions,\n    ): Promise<void>;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,6BAAO;AAEP,kBAGO;AAEP,IAAAA,0BAKO;AAEP,IAAAA,0BAA0B;AAgB1B,0BAAc,6BA9Bd;AAgBO,IAAM,OAA8B,YAAAC,KAAe,OAAO;AAAA,EAC/D,SAAS,OAAO,EAAE,QAAQ,GAAG,QAAQ;AACnC,UAAM,QAAI,wCAAe,OAAO,CAAC;AAAA,EACnC;AAAA,EACA,SAAS,OAAO,EAAE,QAAQ,GAAG,QAAQ;AACnC,UAAM,QAAI,+CAAsB,OAAO,CAAC;AAAA,EAC1C;AAAA,EACA,MAAM,OAAO,EAAE,KAAK,GAAG,QAAQ;AAC7B,UAAM,QAAI,qCAAY,IAAI,CAAC;AAAA,EAC7B;AACF,CAAC;AAEM,IAAM,SAAS,YAAAC,OAAiB,OAAO,gDAAwB;","names":["import_playwright_base","playwrightTest","playwrightExpect"]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import \"@stablyai/playwright-base\";\n\nimport {\n  expect as playwrightExpect,\n  test as playwrightTest,\n} from \"@stablyai/internal-playwright-test\";\n\nimport {\n  augmentBrowser,\n  augmentBrowserContext,\n  augmentPage,\n  stablyPlaywrightMatchers,\n} from \"@stablyai/playwright-base\";\n\nexport { setApiKey } from \"@stablyai/playwright-base\";\n\nexport const test: typeof playwrightTest = playwrightTest.extend({\n  browser: async ({ browser }, use) => {\n    await use(augmentBrowser(browser));\n  },\n  context: async ({ context }, use) => {\n    await use(augmentBrowserContext(context));\n  },\n  page: async ({ page }, use) => {\n    await use(augmentPage(page));\n  },\n});\n\nexport const expect = playwrightExpect.extend(stablyPlaywrightMatchers);\n\nexport * from \"@stablyai/internal-playwright-test\";\n\ndeclare module \"@stablyai/internal-playwright-test\" {\n  export type ScreenshotPromptOptions =\n    import(\"@stablyai/internal-playwright-test\").PageAssertionsToHaveScreenshotOptions;\n\n  interface LocatorAssertions {\n    toMatchScreenshotPrompt(\n      condition: string,\n      options?: ScreenshotPromptOptions,\n    ): Promise<void>;\n  }\n\n  interface PageAssertions {\n    toMatchScreenshotPrompt(\n      condition: string,\n      options?: ScreenshotPromptOptions,\n    ): Promise<void>;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,6BAAO;AAEP,sCAGO;AAEP,IAAAA,0BAKO;AAEP,IAAAA,0BAA0B;AAgB1B,0BAAc,+CA9Bd;AAgBO,IAAM,OAA8B,gCAAAC,KAAe,OAAO;AAAA,EAC/D,SAAS,OAAO,EAAE,QAAQ,GAAG,QAAQ;AACnC,UAAM,QAAI,wCAAe,OAAO,CAAC;AAAA,EACnC;AAAA,EACA,SAAS,OAAO,EAAE,QAAQ,GAAG,QAAQ;AACnC,UAAM,QAAI,+CAAsB,OAAO,CAAC;AAAA,EAC1C;AAAA,EACA,MAAM,OAAO,EAAE,KAAK,GAAG,QAAQ;AAC7B,UAAM,QAAI,qCAAY,IAAI,CAAC;AAAA,EAC7B;AACF,CAAC;AAEM,IAAM,SAAS,gCAAAC,OAAiB,OAAO,gDAAwB;","names":["import_playwright_base","playwrightTest","playwrightExpect"]}

package/dist/index.mjs

@@ -3,7 +3,7 @@ import "@stablyai/playwright-base";
 import {
   expect as playwrightExpect,
   test as playwrightTest
-} from "@playwright/test";
+} from "@stablyai/internal-playwright-test";
 import {
   augmentBrowser,
   augmentBrowserContext,
@@ -11,7 +11,7 @@ import {
   stablyPlaywrightMatchers
 } from "@stablyai/playwright-base";
 import { setApiKey } from "@stablyai/playwright-base";
-export * from "@playwright/test";
+export * from "@stablyai/internal-playwright-test";
 var test = playwrightTest.extend({
   browser: async ({ browser }, use) => {
     await use(augmentBrowser(browser));

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import '@stablyai/playwright-base';\n\nimport {\n  expect as playwrightExpect,\n  test as playwrightTest,\n} from '@playwright/test';\n\nimport {\n  augmentBrowser,\n  augmentBrowserContext,\n  augmentPage,\n  stablyPlaywrightMatchers,\n} from '@stablyai/playwright-base';\n\nexport { setApiKey } from '@stablyai/playwright-base';\n\nexport const test: typeof playwrightTest = playwrightTest.extend({\n  browser: async ({ browser }, use) => {\n    await use(augmentBrowser(browser));\n  },\n  context: async ({ context }, use) => {\n    await use(augmentBrowserContext(context));\n  },\n  page: async ({ page }, use) => {\n    await use(augmentPage(page));\n  },\n});\n\nexport const expect = playwrightExpect.extend(stablyPlaywrightMatchers);\n\nexport * from '@playwright/test';\n\ndeclare module '@playwright/test' {\n  export type ScreenshotPromptOptions =\n    import('@playwright/test').PageAssertionsToHaveScreenshotOptions;\n\n  interface LocatorAssertions {\n    toMatchScreenshotPrompt(\n      condition: string,\n      options?: ScreenshotPromptOptions,\n    ): Promise<void>;\n  }\n\n  interface PageAssertions {\n    toMatchScreenshotPrompt(\n      condition: string,\n      options?: ScreenshotPromptOptions,\n    ): Promise<void>;\n  }\n}\n"],"mappings":";AAAA,OAAO;AAEP;AAAA,EACE,UAAU;AAAA,EACV,QAAQ;AAAA,OACH;AAEP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP,SAAS,iBAAiB;AAgB1B,cAAc;AAdP,IAAM,OAA8B,eAAe,OAAO;AAAA,EAC/D,SAAS,OAAO,EAAE,QAAQ,GAAG,QAAQ;AACnC,UAAM,IAAI,eAAe,OAAO,CAAC;AAAA,EACnC;AAAA,EACA,SAAS,OAAO,EAAE,QAAQ,GAAG,QAAQ;AACnC,UAAM,IAAI,sBAAsB,OAAO,CAAC;AAAA,EAC1C;AAAA,EACA,MAAM,OAAO,EAAE,KAAK,GAAG,QAAQ;AAC7B,UAAM,IAAI,YAAY,IAAI,CAAC;AAAA,EAC7B;AACF,CAAC;AAEM,IAAM,SAAS,iBAAiB,OAAO,wBAAwB;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import \"@stablyai/playwright-base\";\n\nimport {\n  expect as playwrightExpect,\n  test as playwrightTest,\n} from \"@stablyai/internal-playwright-test\";\n\nimport {\n  augmentBrowser,\n  augmentBrowserContext,\n  augmentPage,\n  stablyPlaywrightMatchers,\n} from \"@stablyai/playwright-base\";\n\nexport { setApiKey } from \"@stablyai/playwright-base\";\n\nexport const test: typeof playwrightTest = playwrightTest.extend({\n  browser: async ({ browser }, use) => {\n    await use(augmentBrowser(browser));\n  },\n  context: async ({ context }, use) => {\n    await use(augmentBrowserContext(context));\n  },\n  page: async ({ page }, use) => {\n    await use(augmentPage(page));\n  },\n});\n\nexport const expect = playwrightExpect.extend(stablyPlaywrightMatchers);\n\nexport * from \"@stablyai/internal-playwright-test\";\n\ndeclare module \"@stablyai/internal-playwright-test\" {\n  export type ScreenshotPromptOptions =\n    import(\"@stablyai/internal-playwright-test\").PageAssertionsToHaveScreenshotOptions;\n\n  interface LocatorAssertions {\n    toMatchScreenshotPrompt(\n      condition: string,\n      options?: ScreenshotPromptOptions,\n    ): Promise<void>;\n  }\n\n  interface PageAssertions {\n    toMatchScreenshotPrompt(\n      condition: string,\n      options?: ScreenshotPromptOptions,\n    ): Promise<void>;\n  }\n}\n"],"mappings":";AAAA,OAAO;AAEP;AAAA,EACE,UAAU;AAAA,EACV,QAAQ;AAAA,OACH;AAEP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP,SAAS,iBAAiB;AAgB1B,cAAc;AAdP,IAAM,OAA8B,eAAe,OAAO;AAAA,EAC/D,SAAS,OAAO,EAAE,QAAQ,GAAG,QAAQ;AACnC,UAAM,IAAI,eAAe,OAAO,CAAC;AAAA,EACnC;AAAA,EACA,SAAS,OAAO,EAAE,QAAQ,GAAG,QAAQ;AACnC,UAAM,IAAI,sBAAsB,OAAO,CAAC;AAAA,EAC1C;AAAA,EACA,MAAM,OAAO,EAAE,KAAK,GAAG,QAAQ;AAC7B,UAAM,IAAI,YAAY,IAAI,CAAC;AAAA,EAC7B;AACF,CAAC;AAEM,IAAM,SAAS,iBAAiB,OAAO,wBAAwB;","names":[]}

package/package.json

@@ -1,10 +1,18 @@
 {
   "name": "@stablyai/playwright-test",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Playwright Test wrapper with Stably AI matchers",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "bin": {
+    "playwright": "cli.js"
+  },
+  "files": [
+    "dist",
+    "cli.js"
+  ],
   "dependencies": {
+    "@stablyai/internal-playwright-test": "^0.1.1",
     "@stablyai/playwright": "^0.1.0",
     "@stablyai/playwright-base": "^0.1.0"
   },
@@ -12,9 +20,7 @@
     "tsup": "^8.5.0"
   },
   "peerDependencies": {
-    "@playwright/test": "^1.44.0",
-    "playwright": "^1.44.0",
-    "zod": "^3.0.0"
+    "zod": "^3.25.0 || ^4.0.0"
   },
   "scripts": {
     "build": "tsup --config tsup.config.ts"

package/src/index.ts

@@ -1,50 +0,0 @@
-import '@stablyai/playwright-base';
-
-import {
-  expect as playwrightExpect,
-  test as playwrightTest,
-} from '@playwright/test';
-
-import {
-  augmentBrowser,
-  augmentBrowserContext,
-  augmentPage,
-  stablyPlaywrightMatchers,
-} from '@stablyai/playwright-base';
-
-export { setApiKey } from '@stablyai/playwright-base';
-
-export const test: typeof playwrightTest = playwrightTest.extend({
-  browser: async ({ browser }, use) => {
-    await use(augmentBrowser(browser));
-  },
-  context: async ({ context }, use) => {
-    await use(augmentBrowserContext(context));
-  },
-  page: async ({ page }, use) => {
-    await use(augmentPage(page));
-  },
-});
-
-export const expect = playwrightExpect.extend(stablyPlaywrightMatchers);
-
-export * from '@playwright/test';
-
-declare module '@playwright/test' {
-  export type ScreenshotPromptOptions =
-    import('@playwright/test').PageAssertionsToHaveScreenshotOptions;
-
-  interface LocatorAssertions {
-    toMatchScreenshotPrompt(
-      condition: string,
-      options?: ScreenshotPromptOptions,
-    ): Promise<void>;
-  }
-
-  interface PageAssertions {
-    toMatchScreenshotPrompt(
-      condition: string,
-      options?: ScreenshotPromptOptions,
-    ): Promise<void>;
-  }
-}

package/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "rootDir": "src",
-    "outDir": "dist"
-  },
-  "include": ["src"],
-  "exclude": ["dist", "node_modules"]
-}

package/tsup.config.ts

@@ -1,20 +0,0 @@
-import { defineConfig } from 'tsup';
-
-export default defineConfig({
-  entry: ['src/index.ts'],
-  format: ['cjs', 'esm'],
-  splitting: false,
-  sourcemap: true,
-  clean: true,
-  dts: {
-    banner: 'import "@stablyai/playwright-base";',
-  },
-  target: 'es2019',
-  outDir: 'dist',
-  platform: 'node',
-  external: [
-    '@playwright/test',
-    '@stablyai/playwright',
-    '@stablyai/playwright-base',
-  ],
-});