@airtop/plugin-puppeteer 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,23 @@
+"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.getWindowForPuppeteerPage = async function(page, options, requestOptions) {
+      const frameId = page.mainFrame()._id;
+      if (!frameId) {
+        throw new Error("Could not get frame ID from Puppeteer page");
+      }
+      return this.withWindowId(frameId).getWindowInfo(options, requestOptions);
+    };
+  }
+};
+function puppeteerPlugin() {
+  return {
+    pluginsToAdd: [plugin]
+  };
+}
+
+
+exports.puppeteerPlugin = puppeteerPlugin;
+//# 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/puppeteer/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,0BAAA,EAA4B,MAAA,QAAA,CACpC,IAAA,EACA,OAAA,EACA,cAAA,EACA;AACA,MAAA,MAAM,QAAA,EAAW,IAAA,CAAK,SAAA,CAAU,CAAA,CAAU,GAAA;AAE1C,MAAA,GAAA,CAAI,CAAC,OAAA,EAAS;AACZ,QAAA,MAAM,IAAI,KAAA,CAAM,4CAA4C,CAAA;AAAA,MAC9D;AAEA,MAAA,OAAO,IAAA,CAAK,YAAA,CAAa,OAAO,CAAA,CAAE,aAAA,CAAc,OAAA,EAAS,cAAc,CAAA;AAAA,IACzE,CAAA;AAAA,EACF;AACF,CAAA;AAKO,SAAS,eAAA,CAAA,EAA4C;AAC1D,EAAA,OAAO;AAAA,IACL,YAAA,EAAc,CAAC,MAAM;AAAA,EACvB,CAAA;AACF;ADnDA;AACE;AACF,0CAAC","file":"/Users/theo/projects/monarch/sdk-v2/wrapper-sdks/typescript/packages/plugins/puppeteer/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 \"puppeteer\";\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 Puppeteer plugin.\n */\nexport interface PuppeteerPluginMethods {\n  /**\n   * Get the window information for a Puppeteer Page instance.\n   * @param page The Puppeteer 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  getWindowForPuppeteerPage(\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 Puppeteer Page instance.\n     * @param page The Puppeteer 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    getWindowForPuppeteerPage(\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.getWindowForPuppeteerPage = async function (\n      page: Page,\n      options?: WindowGetConfig,\n      requestOptions?: AirtopRequestOptions,\n    ) {\n      const frameId = (page.mainFrame() as any)._id;\n\n      if (!frameId) {\n        throw new Error(\"Could not get frame ID from Puppeteer page\");\n      }\n\n      return this.withWindowId(frameId).getWindowInfo(options, requestOptions);\n    };\n  },\n};\n\n/**\n * Use with registerAirtopPlugin() from the Airtop SDK to add the Puppeteer plugin.\n */\nexport function puppeteerPlugin(): 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 'puppeteer';
+
+/**
+ * The methods provided by the Puppeteer plugin.
+ */
+interface PuppeteerPluginMethods {
+    /**
+     * Get the window information for a Puppeteer Page instance.
+     * @param page The Puppeteer 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.
+     */
+    getWindowForPuppeteerPage(page: Page, options?: WindowGetConfig, requestOptions?: AirtopRequestOptions): Promise<AirtopWindow<AirtopWindowGetInfoResponse>>;
+}
+declare module "@airtop/sdk" {
+    interface AirtopSessionClient {
+        /**
+         * Get the window information for a Puppeteer Page instance.
+         * @param page The Puppeteer 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.
+         */
+        getWindowForPuppeteerPage(page: Page, options?: WindowGetConfig, requestOptions?: AirtopRequestOptions): Promise<AirtopWindow<AirtopWindowGetInfoResponse>>;
+    }
+}
+/**
+ * Use with registerAirtopPlugin() from the Airtop SDK to add the Puppeteer plugin.
+ */
+declare function puppeteerPlugin(): AirtopPluginRegistration;
+
+export { type PuppeteerPluginMethods, puppeteerPlugin };

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+import { WindowGetConfig, AirtopRequestOptions, AirtopWindow, AirtopWindowGetInfoResponse, AirtopPluginRegistration } from '@airtop/sdk';
+import { Page } from 'puppeteer';
+
+/**
+ * The methods provided by the Puppeteer plugin.
+ */
+interface PuppeteerPluginMethods {
+    /**
+     * Get the window information for a Puppeteer Page instance.
+     * @param page The Puppeteer 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.
+     */
+    getWindowForPuppeteerPage(page: Page, options?: WindowGetConfig, requestOptions?: AirtopRequestOptions): Promise<AirtopWindow<AirtopWindowGetInfoResponse>>;
+}
+declare module "@airtop/sdk" {
+    interface AirtopSessionClient {
+        /**
+         * Get the window information for a Puppeteer Page instance.
+         * @param page The Puppeteer 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.
+         */
+        getWindowForPuppeteerPage(page: Page, options?: WindowGetConfig, requestOptions?: AirtopRequestOptions): Promise<AirtopWindow<AirtopWindowGetInfoResponse>>;
+    }
+}
+/**
+ * Use with registerAirtopPlugin() from the Airtop SDK to add the Puppeteer plugin.
+ */
+declare function puppeteerPlugin(): AirtopPluginRegistration;
+
+export { type PuppeteerPluginMethods, puppeteerPlugin };

package/dist/index.js

@@ -0,0 +1,23 @@
+// src/index.ts
+import { AirtopPluginAugmentationType } from "@airtop/sdk";
+var plugin = {
+  augmentationType: AirtopPluginAugmentationType.AirtopSessionClient,
+  augment: (prototype) => {
+    prototype.getWindowForPuppeteerPage = async function(page, options, requestOptions) {
+      const frameId = page.mainFrame()._id;
+      if (!frameId) {
+        throw new Error("Could not get frame ID from Puppeteer page");
+      }
+      return this.withWindowId(frameId).getWindowInfo(options, requestOptions);
+    };
+  }
+};
+function puppeteerPlugin() {
+  return {
+    pluginsToAdd: [plugin]
+  };
+}
+export {
+  puppeteerPlugin
+};
+//# 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 \"puppeteer\";\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 Puppeteer plugin.\n */\nexport interface PuppeteerPluginMethods {\n  /**\n   * Get the window information for a Puppeteer Page instance.\n   * @param page The Puppeteer 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  getWindowForPuppeteerPage(\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 Puppeteer Page instance.\n     * @param page The Puppeteer 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    getWindowForPuppeteerPage(\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.getWindowForPuppeteerPage = async function (\n      page: Page,\n      options?: WindowGetConfig,\n      requestOptions?: AirtopRequestOptions,\n    ) {\n      const frameId = (page.mainFrame() as any)._id;\n\n      if (!frameId) {\n        throw new Error(\"Could not get frame ID from Puppeteer page\");\n      }\n\n      return this.withWindowId(frameId).getWindowInfo(options, requestOptions);\n    };\n  },\n};\n\n/**\n * Use with registerAirtopPlugin() from the Airtop SDK to add the Puppeteer plugin.\n */\nexport function puppeteerPlugin(): 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,4BAA4B,eACpC,MACA,SACA,gBACA;AACA,YAAM,UAAW,KAAK,UAAU,EAAU;AAE1C,UAAI,CAAC,SAAS;AACZ,cAAM,IAAI,MAAM,4CAA4C;AAAA,MAC9D;AAEA,aAAO,KAAK,aAAa,OAAO,EAAE,cAAc,SAAS,cAAc;AAAA,IACzE;AAAA,EACF;AACF;AAKO,SAAS,kBAA4C;AAC1D,SAAO;AAAA,IACL,cAAc,CAAC,MAAM;AAAA,EACvB;AACF;","names":[]}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@airtop/plugin-puppeteer",
+  "description": "Adds puppeteer 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",
+    "puppeteer",
+    "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:*",
+    "puppeteer": ">=22.14.0"
+  },
+  "bugs": "https://github.com/airtop-ai/airtop-sdk/issues",
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "dist"
+  ],
+  "homepage": "https://airtop.ai",
+  "packageManager": "pnpm@10.5.0"
+}