@airtop/plugin-playwright 1.0.0-alpha2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Airtop
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs

@@ -0,0 +1,25 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/index.ts
+var _sdk = require('@airtop/sdk');
+var plugin = {
+  augmentationType: _sdk.AirtopPluginAugmentationType.AirtopSessionClient,
+  augment: (prototype) => {
+    prototype.getWindowInfoForPlaywrightPage = async function(page, options, requestOptions) {
+      const cdpSession = await page.context().newCDPSession(page);
+      const { targetInfo } = await cdpSession.send("Target.getTargetInfo");
+      const targetId = targetInfo.targetId;
+      if (!targetId) {
+        throw new Error("TargetId not found");
+      }
+      return await this.withWindowId(targetId).getWindowInfo(options, requestOptions);
+    };
+  }
+};
+function playwrightPlugin() {
+  return {
+    pluginsToAdd: [plugin]
+  };
+}
+
+
+exports.playwrightPlugin = playwrightPlugin;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["/Users/theo/projects/monarch/sdk-v2/wrapper-sdks/typescript/packages/plugins/playwright/dist/index.cjs","../src/index.ts"],"names":[],"mappings":"AAAA;ACAA,kCAA6C;AA4C7C,IAAM,OAAA,EAAoC;AAAA,EACxC,gBAAA,EAAkB,iCAAA,CAA6B,mBAAA;AAAA,EAC/C,OAAA,EAAS,CAAC,SAAA,EAAA,GAAoD;AAC5D,IAAA,SAAA,CAAU,+BAAA,EAAiC,MAAA,QAAA,CACzC,IAAA,EACA,OAAA,EACA,cAAA,EACA;AACA,MAAA,MAAM,WAAA,EAAa,MAAM,IAAA,CAAK,OAAA,CAAQ,CAAA,CAAE,aAAA,CAAc,IAAI,CAAA;AAC1D,MAAA,MAAM,EAAE,WAAW,EAAA,EAAI,MAAM,UAAA,CAAW,IAAA,CAAK,sBAAsB,CAAA;AACnE,MAAA,MAAM,SAAA,EAAW,UAAA,CAAW,QAAA;AAC5B,MAAA,GAAA,CAAI,CAAC,QAAA,EAAU;AACb,QAAA,MAAM,IAAI,KAAA,CAAM,oBAAoB,CAAA;AAAA,MACtC;AAEA,MAAA,OAAO,MAAM,IAAA,CAAK,YAAA,CAAa,QAAQ,CAAA,CAAE,aAAA,CAAc,OAAA,EAAS,cAAc,CAAA;AAAA,IAChF,CAAA;AAAA,EACF;AACF,CAAA;AAKO,SAAS,gBAAA,CAAA,EAA6C;AAC3D,EAAA,OAAO;AAAA,IACL,YAAA,EAAc,CAAC,MAAM;AAAA,EACvB,CAAA;AACF;ADlDA;AACE;AACF,4CAAC","file":"/Users/theo/projects/monarch/sdk-v2/wrapper-sdks/typescript/packages/plugins/playwright/dist/index.cjs","sourcesContent":[null,"import { AirtopPluginAugmentationType } from \"@airtop/sdk\";\nimport type { AirtopSessionClient, AirtopSessionClientPlugin } from \"@airtop/sdk\";\nimport type { AirtopRequestOptions } from \"@airtop/sdk\";\nimport type { AirtopWindow } from \"@airtop/sdk\";\nimport type { WindowGetConfig } from \"@airtop/sdk\";\nimport type { AirtopPluginRegistration } from \"@airtop/sdk\";\nimport type { AirtopWindowGetInfoResponse } from \"@airtop/sdk\";\nimport type { Page } from \"playwright\";\n\n// This is exported so the docs can expose it as we can't generate docs against the\n// module declaration\n/**\n * The methods provided by the Playwright plugin.\n */\nexport interface PlaywrightPluginMethods {\n  /**\n   * Get the window information for a Playwright Page instance.\n   * @param page The Playwright Page instance to get window information for.\n   * @param options Configuration options for the window info request.\n   * @param requestOptions Additional options to customize the request behavior.\n   */\n  getWindowInfoForPlaywrightPage(\n    page: Page,\n    options?: WindowGetConfig,\n    requestOptions?: AirtopRequestOptions,\n  ): Promise<AirtopWindow<AirtopWindowGetInfoResponse>>;\n}\n\ndeclare module \"@airtop/sdk\" {\n  interface AirtopSessionClient {\n    /**\n     * Get the window information for a Playwright Page instance.\n     * @param page The Playwright Page instance to get window information for.\n     * @param options Configuration options for the window info request.\n     * @param requestOptions Additional options to customize the request behavior.\n     */\n    getWindowInfoForPlaywrightPage(\n      page: Page,\n      options?: WindowGetConfig,\n      requestOptions?: AirtopRequestOptions,\n    ): Promise<AirtopWindow<AirtopWindowGetInfoResponse>>;\n  }\n}\n\nconst plugin: AirtopSessionClientPlugin = {\n  augmentationType: AirtopPluginAugmentationType.AirtopSessionClient,\n  augment: (prototype: typeof AirtopSessionClient.prototype) => {\n    prototype.getWindowInfoForPlaywrightPage = async function (\n      page: Page,\n      options: WindowGetConfig,\n      requestOptions: AirtopRequestOptions,\n    ) {\n      const cdpSession = await page.context().newCDPSession(page);\n      const { targetInfo } = await cdpSession.send(\"Target.getTargetInfo\");\n      const targetId = targetInfo.targetId;\n      if (!targetId) {\n        throw new Error(\"TargetId not found\");\n      }\n\n      return await this.withWindowId(targetId).getWindowInfo(options, requestOptions);\n    };\n  },\n};\n\n/**\n * Use with registerAirtopPlugin() from the Airtop SDK to add the Playwright plugin.\n */\nexport function playwrightPlugin(): AirtopPluginRegistration {\n  return {\n    pluginsToAdd: [plugin],\n  };\n}\n"]}

package/dist/index.d.cts

@@ -0,0 +1,32 @@
+import { WindowGetConfig, AirtopRequestOptions, AirtopWindow, AirtopWindowGetInfoResponse, AirtopPluginRegistration } from '@airtop/sdk';
+import { Page } from 'playwright';
+
+/**
+ * The methods provided by the Playwright plugin.
+ */
+interface PlaywrightPluginMethods {
+    /**
+     * Get the window information for a Playwright Page instance.
+     * @param page The Playwright Page instance to get window information for.
+     * @param options Configuration options for the window info request.
+     * @param requestOptions Additional options to customize the request behavior.
+     */
+    getWindowInfoForPlaywrightPage(page: Page, options?: WindowGetConfig, requestOptions?: AirtopRequestOptions): Promise<AirtopWindow<AirtopWindowGetInfoResponse>>;
+}
+declare module "@airtop/sdk" {
+    interface AirtopSessionClient {
+        /**
+         * Get the window information for a Playwright Page instance.
+         * @param page The Playwright Page instance to get window information for.
+         * @param options Configuration options for the window info request.
+         * @param requestOptions Additional options to customize the request behavior.
+         */
+        getWindowInfoForPlaywrightPage(page: Page, options?: WindowGetConfig, requestOptions?: AirtopRequestOptions): Promise<AirtopWindow<AirtopWindowGetInfoResponse>>;
+    }
+}
+/**
+ * Use with registerAirtopPlugin() from the Airtop SDK to add the Playwright plugin.
+ */
+declare function playwrightPlugin(): AirtopPluginRegistration;
+
+export { type PlaywrightPluginMethods, playwrightPlugin };

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+import { WindowGetConfig, AirtopRequestOptions, AirtopWindow, AirtopWindowGetInfoResponse, AirtopPluginRegistration } from '@airtop/sdk';
+import { Page } from 'playwright';
+
+/**
+ * The methods provided by the Playwright plugin.
+ */
+interface PlaywrightPluginMethods {
+    /**
+     * Get the window information for a Playwright Page instance.
+     * @param page The Playwright Page instance to get window information for.
+     * @param options Configuration options for the window info request.
+     * @param requestOptions Additional options to customize the request behavior.
+     */
+    getWindowInfoForPlaywrightPage(page: Page, options?: WindowGetConfig, requestOptions?: AirtopRequestOptions): Promise<AirtopWindow<AirtopWindowGetInfoResponse>>;
+}
+declare module "@airtop/sdk" {
+    interface AirtopSessionClient {
+        /**
+         * Get the window information for a Playwright Page instance.
+         * @param page The Playwright Page instance to get window information for.
+         * @param options Configuration options for the window info request.
+         * @param requestOptions Additional options to customize the request behavior.
+         */
+        getWindowInfoForPlaywrightPage(page: Page, options?: WindowGetConfig, requestOptions?: AirtopRequestOptions): Promise<AirtopWindow<AirtopWindowGetInfoResponse>>;
+    }
+}
+/**
+ * Use with registerAirtopPlugin() from the Airtop SDK to add the Playwright plugin.
+ */
+declare function playwrightPlugin(): AirtopPluginRegistration;
+
+export { type PlaywrightPluginMethods, playwrightPlugin };

package/dist/index.js

@@ -0,0 +1,25 @@
+// src/index.ts
+import { AirtopPluginAugmentationType } from "@airtop/sdk";
+var plugin = {
+  augmentationType: AirtopPluginAugmentationType.AirtopSessionClient,
+  augment: (prototype) => {
+    prototype.getWindowInfoForPlaywrightPage = async function(page, options, requestOptions) {
+      const cdpSession = await page.context().newCDPSession(page);
+      const { targetInfo } = await cdpSession.send("Target.getTargetInfo");
+      const targetId = targetInfo.targetId;
+      if (!targetId) {
+        throw new Error("TargetId not found");
+      }
+      return await this.withWindowId(targetId).getWindowInfo(options, requestOptions);
+    };
+  }
+};
+function playwrightPlugin() {
+  return {
+    pluginsToAdd: [plugin]
+  };
+}
+export {
+  playwrightPlugin
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { AirtopPluginAugmentationType } from \"@airtop/sdk\";\nimport type { AirtopSessionClient, AirtopSessionClientPlugin } from \"@airtop/sdk\";\nimport type { AirtopRequestOptions } from \"@airtop/sdk\";\nimport type { AirtopWindow } from \"@airtop/sdk\";\nimport type { WindowGetConfig } from \"@airtop/sdk\";\nimport type { AirtopPluginRegistration } from \"@airtop/sdk\";\nimport type { AirtopWindowGetInfoResponse } from \"@airtop/sdk\";\nimport type { Page } from \"playwright\";\n\n// This is exported so the docs can expose it as we can't generate docs against the\n// module declaration\n/**\n * The methods provided by the Playwright plugin.\n */\nexport interface PlaywrightPluginMethods {\n  /**\n   * Get the window information for a Playwright Page instance.\n   * @param page The Playwright Page instance to get window information for.\n   * @param options Configuration options for the window info request.\n   * @param requestOptions Additional options to customize the request behavior.\n   */\n  getWindowInfoForPlaywrightPage(\n    page: Page,\n    options?: WindowGetConfig,\n    requestOptions?: AirtopRequestOptions,\n  ): Promise<AirtopWindow<AirtopWindowGetInfoResponse>>;\n}\n\ndeclare module \"@airtop/sdk\" {\n  interface AirtopSessionClient {\n    /**\n     * Get the window information for a Playwright Page instance.\n     * @param page The Playwright Page instance to get window information for.\n     * @param options Configuration options for the window info request.\n     * @param requestOptions Additional options to customize the request behavior.\n     */\n    getWindowInfoForPlaywrightPage(\n      page: Page,\n      options?: WindowGetConfig,\n      requestOptions?: AirtopRequestOptions,\n    ): Promise<AirtopWindow<AirtopWindowGetInfoResponse>>;\n  }\n}\n\nconst plugin: AirtopSessionClientPlugin = {\n  augmentationType: AirtopPluginAugmentationType.AirtopSessionClient,\n  augment: (prototype: typeof AirtopSessionClient.prototype) => {\n    prototype.getWindowInfoForPlaywrightPage = async function (\n      page: Page,\n      options: WindowGetConfig,\n      requestOptions: AirtopRequestOptions,\n    ) {\n      const cdpSession = await page.context().newCDPSession(page);\n      const { targetInfo } = await cdpSession.send(\"Target.getTargetInfo\");\n      const targetId = targetInfo.targetId;\n      if (!targetId) {\n        throw new Error(\"TargetId not found\");\n      }\n\n      return await this.withWindowId(targetId).getWindowInfo(options, requestOptions);\n    };\n  },\n};\n\n/**\n * Use with registerAirtopPlugin() from the Airtop SDK to add the Playwright plugin.\n */\nexport function playwrightPlugin(): AirtopPluginRegistration {\n  return {\n    pluginsToAdd: [plugin],\n  };\n}\n"],"mappings":";AAAA,SAAS,oCAAoC;AA4C7C,IAAM,SAAoC;AAAA,EACxC,kBAAkB,6BAA6B;AAAA,EAC/C,SAAS,CAAC,cAAoD;AAC5D,cAAU,iCAAiC,eACzC,MACA,SACA,gBACA;AACA,YAAM,aAAa,MAAM,KAAK,QAAQ,EAAE,cAAc,IAAI;AAC1D,YAAM,EAAE,WAAW,IAAI,MAAM,WAAW,KAAK,sBAAsB;AACnE,YAAM,WAAW,WAAW;AAC5B,UAAI,CAAC,UAAU;AACb,cAAM,IAAI,MAAM,oBAAoB;AAAA,MACtC;AAEA,aAAO,MAAM,KAAK,aAAa,QAAQ,EAAE,cAAc,SAAS,cAAc;AAAA,IAChF;AAAA,EACF;AACF;AAKO,SAAS,mBAA6C;AAC3D,SAAO;AAAA,IACL,cAAc,CAAC,MAAM;AAAA,EACvB;AACF;","names":[]}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@airtop/plugin-playwright",
+  "description": "Adds Playwright support to the Airtop SDK",
+  "version": "1.0.0-alpha2.0",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "exports": {
+    "import": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "require": {
+      "types": "./dist/index.d.cts",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "license": "MIT",
+  "repository": "airtop-ai/airtop-sdk.git",
+  "author": "Theo Gravity <theo@airtop.ai>",
+  "keywords": [
+    "airtop",
+    "playwright",
+    "plugin"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts",
+    "test": "vitest --run",
+    "build:dev": "node_modules/.bin/hash-runner",
+    "clean": "rm -rf .turbo node_modules dist",
+    "lint": "biome check --write --unsafe src && biome format src --write && biome lint src --fix",
+    "verify-types": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "1.9.4",
+    "@internal/tsconfig": "workspace:*",
+    "hash-runner": "2.0.1",
+    "tsup": "8.4.0",
+    "typescript": "5.8.2",
+    "vitest": "3.1.1"
+  },
+  "peerDependencies": {
+    "@airtop/sdk": "workspace:*",
+    "playwright": ">=1.51.1"
+  },
+  "bugs": "https://github.com/airtop-ai/airtop-sdk/issues",
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "dist"
+  ],
+  "homepage": "https://airtop.ai",
+  "packageManager": "pnpm@10.5.0"
+}