@stablyai/playwright-test 0.1.1 → 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/package.json

@@ -1,12 +1,16 @@
 {
   "name": "@stablyai/playwright-test",
-  "version": "0.1.1",
+  "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",

package/src/index.ts

@@ -1,50 +0,0 @@
-import "@stablyai/playwright-base";
-
-import {
-  expect as playwrightExpect,
-  test as playwrightTest,
-} from "@stablyai/internal-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 "@stablyai/internal-playwright-test";
-
-declare module "@stablyai/internal-playwright-test" {
-  export type ScreenshotPromptOptions =
-    import("@stablyai/internal-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,19 +0,0 @@
-{
-  "extends": "@tsconfig/node18/tsconfig.json",
-  "compilerOptions": {
-    "declaration": true,
-    "outDir": "./dist",
-    "rootDir": "src",
-    "forceConsistentCasingInFileNames": true,
-    "resolveJsonModule": true,
-    "noEmit": true,
-    "moduleResolution": "bundler",
-    "module": "ESNext",
-    "baseUrl": ".",
-    "paths": {
-      "~/*": ["src/*"]
-    }
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist"]
-}

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",
-  ],
-});