@askjo/camoufox-browser 1.0.2 → 1.0.5

package/package.json

@@ -1,8 +1,46 @@
 {
   "name": "@askjo/camoufox-browser",
-  "version": "1.0.2",
+  "version": "1.0.5",
   "description": "Headless browser automation server and OpenClaw plugin for AI agents - anti-detection, element refs, and session isolation",
   "main": "server-camoufox.js",
+  "license": "MIT",
+  "author": "Jo Inc <hello@askjo.ai>",
+  "homepage": "https://github.com/jo-inc/camoufox-browser#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jo-inc/camoufox-browser.git"
+  },
+  "bugs": {
+    "url": "https://github.com/jo-inc/camoufox-browser/issues"
+  },
+  "keywords": [
+    "browser",
+    "automation",
+    "headless",
+    "scraping",
+    "camoufox",
+    "anti-detection",
+    "ai-agent",
+    "openclaw",
+    "clawdbot",
+    "moltbot",
+    "playwright",
+    "firefox"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "server-camoufox.js",
+    "lib/",
+    "plugin.ts",
+    "openclaw.plugin.json",
+    "run-camoufox.sh",
+    "Dockerfile.camoufox",
+    "SKILL.md",
+    "README.md",
+    "LICENSE"
+  ],
   "openclaw": {
     "extensions": ["plugin.ts"]
   },

package/plugin.ts

@@ -13,14 +13,20 @@ interface PluginConfig {
   autoStart?: boolean;
 }
 
+interface ToolResult {
+  content: Array<{ type: string; text: string }>;
+}
+
 interface PluginApi {
-  registerTool: (tool: {
-    name: string;
-    description: string;
-    parameters: object;
-    optional?: boolean;
-    handler: (params: Record<string, unknown>) => Promise<unknown>;
-  }) => void;
+  registerTool: (
+    tool: {
+      name: string;
+      description: string;
+      parameters: object;
+      execute: (id: string, params: Record<string, unknown>) => Promise<ToolResult>;
+    },
+    options?: { optional?: boolean }
+  ) => void;
   registerCommand: (cmd: {
     name: string;
     description: string;
@@ -55,218 +61,251 @@ async function fetchApi(
   return res.json();
 }
 
+function toToolResult(data: unknown): ToolResult {
+  return {
+    content: [{ type: "text", text: JSON.stringify(data, null, 2) }],
+  };
+}
+
 export default function register(api: PluginApi) {
   const baseUrl = api.config.url || "http://localhost:9377";
 
-  api.registerTool({
-    name: "camoufox_create_tab",
-    description:
-      "Create a new browser tab. Returns tabId for subsequent operations.",
-    parameters: {
-      type: "object",
-      properties: {
-        userId: { type: "string", description: "User identifier for session isolation" },
-        listItemId: { type: "string", description: "Conversation/task identifier for tab grouping" },
-        url: { type: "string", description: "Initial URL to navigate to" },
+  api.registerTool(
+    {
+      name: "camoufox_create_tab",
+      description:
+        "Create a new browser tab. Returns tabId for subsequent operations.",
+      parameters: {
+        type: "object",
+        properties: {
+          userId: { type: "string", description: "User identifier for session isolation" },
+          listItemId: { type: "string", description: "Conversation/task identifier for tab grouping" },
+          url: { type: "string", description: "Initial URL to navigate to" },
+        },
+        required: ["userId", "url"],
+      },
+      async execute(_id, params) {
+        const result = await fetchApi(baseUrl, "/tabs", {
+          method: "POST",
+          body: JSON.stringify(params),
+        });
+        return toToolResult(result);
       },
-      required: ["userId", "url"],
-    },
-    optional: true,
-    handler: async (params) => {
-      return fetchApi(baseUrl, "/tabs", {
-        method: "POST",
-        body: JSON.stringify(params),
-      });
     },
-  });
+    { optional: true }
+  );
 
-  api.registerTool({
-    name: "camoufox_snapshot",
-    description:
-      "Get accessibility snapshot of a page with element refs (e1, e2, etc.) for interaction.",
-    parameters: {
-      type: "object",
-      properties: {
-        tabId: { type: "string", description: "Tab identifier" },
-        userId: { type: "string", description: "User identifier" },
+  api.registerTool(
+    {
+      name: "camoufox_snapshot",
+      description:
+        "Get accessibility snapshot of a page with element refs (e1, e2, etc.) for interaction.",
+      parameters: {
+        type: "object",
+        properties: {
+          tabId: { type: "string", description: "Tab identifier" },
+          userId: { type: "string", description: "User identifier" },
+        },
+        required: ["tabId", "userId"],
+      },
+      async execute(_id, params) {
+        const { tabId, userId } = params as { tabId: string; userId: string };
+        const result = await fetchApi(baseUrl, `/tabs/${tabId}/snapshot?userId=${userId}`);
+        return toToolResult(result);
       },
-      required: ["tabId", "userId"],
-    },
-    optional: true,
-    handler: async (params) => {
-      const { tabId, userId } = params as { tabId: string; userId: string };
-      return fetchApi(baseUrl, `/tabs/${tabId}/snapshot?userId=${userId}`);
     },
-  });
+    { optional: true }
+  );
 
-  api.registerTool({
-    name: "camoufox_click",
-    description: "Click an element by ref (e.g., e1) or CSS selector.",
-    parameters: {
-      type: "object",
-      properties: {
-        tabId: { type: "string", description: "Tab identifier" },
-        userId: { type: "string", description: "User identifier" },
-        ref: { type: "string", description: "Element ref from snapshot (e.g., e1)" },
-        selector: { type: "string", description: "CSS selector (alternative to ref)" },
+  api.registerTool(
+    {
+      name: "camoufox_click",
+      description: "Click an element by ref (e.g., e1) or CSS selector.",
+      parameters: {
+        type: "object",
+        properties: {
+          tabId: { type: "string", description: "Tab identifier" },
+          userId: { type: "string", description: "User identifier" },
+          ref: { type: "string", description: "Element ref from snapshot (e.g., e1)" },
+          selector: { type: "string", description: "CSS selector (alternative to ref)" },
+        },
+        required: ["tabId", "userId"],
+      },
+      async execute(_id, params) {
+        const { tabId, ...body } = params as { tabId: string } & Record<string, unknown>;
+        const result = await fetchApi(baseUrl, `/tabs/${tabId}/click`, {
+          method: "POST",
+          body: JSON.stringify(body),
+        });
+        return toToolResult(result);
       },
-      required: ["tabId", "userId"],
-    },
-    optional: true,
-    handler: async (params) => {
-      const { tabId, ...body } = params as { tabId: string } & Record<string, unknown>;
-      return fetchApi(baseUrl, `/tabs/${tabId}/click`, {
-        method: "POST",
-        body: JSON.stringify(body),
-      });
     },
-  });
+    { optional: true }
+  );
 
-  api.registerTool({
-    name: "camoufox_type",
-    description: "Type text into an element.",
-    parameters: {
-      type: "object",
-      properties: {
-        tabId: { type: "string", description: "Tab identifier" },
-        userId: { type: "string", description: "User identifier" },
-        ref: { type: "string", description: "Element ref from snapshot (e.g., e2)" },
-        selector: { type: "string", description: "CSS selector (alternative to ref)" },
-        text: { type: "string", description: "Text to type" },
-        pressEnter: { type: "boolean", description: "Press Enter after typing" },
+  api.registerTool(
+    {
+      name: "camoufox_type",
+      description: "Type text into an element.",
+      parameters: {
+        type: "object",
+        properties: {
+          tabId: { type: "string", description: "Tab identifier" },
+          userId: { type: "string", description: "User identifier" },
+          ref: { type: "string", description: "Element ref from snapshot (e.g., e2)" },
+          selector: { type: "string", description: "CSS selector (alternative to ref)" },
+          text: { type: "string", description: "Text to type" },
+          pressEnter: { type: "boolean", description: "Press Enter after typing" },
+        },
+        required: ["tabId", "userId", "text"],
+      },
+      async execute(_id, params) {
+        const { tabId, ...body } = params as { tabId: string } & Record<string, unknown>;
+        const result = await fetchApi(baseUrl, `/tabs/${tabId}/type`, {
+          method: "POST",
+          body: JSON.stringify(body),
+        });
+        return toToolResult(result);
       },
-      required: ["tabId", "userId", "text"],
-    },
-    optional: true,
-    handler: async (params) => {
-      const { tabId, ...body } = params as { tabId: string } & Record<string, unknown>;
-      return fetchApi(baseUrl, `/tabs/${tabId}/type`, {
-        method: "POST",
-        body: JSON.stringify(body),
-      });
     },
-  });
+    { optional: true }
+  );
 
-  api.registerTool({
-    name: "camoufox_navigate",
-    description:
-      "Navigate to a URL or use a search macro (@google_search, @youtube_search, etc.).",
-    parameters: {
-      type: "object",
-      properties: {
-        tabId: { type: "string", description: "Tab identifier" },
-        userId: { type: "string", description: "User identifier" },
-        url: { type: "string", description: "URL to navigate to" },
-        macro: {
-          type: "string",
-          description: "Search macro (e.g., @google_search, @youtube_search)",
-          enum: [
-            "@google_search",
-            "@youtube_search",
-            "@amazon_search",
-            "@reddit_search",
-            "@wikipedia_search",
-            "@twitter_search",
-            "@yelp_search",
-            "@spotify_search",
-            "@netflix_search",
-            "@linkedin_search",
-            "@instagram_search",
-            "@tiktok_search",
-            "@twitch_search",
-          ],
+  api.registerTool(
+    {
+      name: "camoufox_navigate",
+      description:
+        "Navigate to a URL or use a search macro (@google_search, @youtube_search, etc.).",
+      parameters: {
+        type: "object",
+        properties: {
+          tabId: { type: "string", description: "Tab identifier" },
+          userId: { type: "string", description: "User identifier" },
+          url: { type: "string", description: "URL to navigate to" },
+          macro: {
+            type: "string",
+            description: "Search macro (e.g., @google_search, @youtube_search)",
+            enum: [
+              "@google_search",
+              "@youtube_search",
+              "@amazon_search",
+              "@reddit_search",
+              "@wikipedia_search",
+              "@twitter_search",
+              "@yelp_search",
+              "@spotify_search",
+              "@netflix_search",
+              "@linkedin_search",
+              "@instagram_search",
+              "@tiktok_search",
+              "@twitch_search",
+            ],
+          },
+          query: { type: "string", description: "Search query (when using macro)" },
         },
-        query: { type: "string", description: "Search query (when using macro)" },
+        required: ["tabId", "userId"],
+      },
+      async execute(_id, params) {
+        const { tabId, ...body } = params as { tabId: string } & Record<string, unknown>;
+        const result = await fetchApi(baseUrl, `/tabs/${tabId}/navigate`, {
+          method: "POST",
+          body: JSON.stringify(body),
+        });
+        return toToolResult(result);
       },
-      required: ["tabId", "userId"],
-    },
-    optional: true,
-    handler: async (params) => {
-      const { tabId, ...body } = params as { tabId: string } & Record<string, unknown>;
-      return fetchApi(baseUrl, `/tabs/${tabId}/navigate`, {
-        method: "POST",
-        body: JSON.stringify(body),
-      });
     },
-  });
+    { optional: true }
+  );
 
-  api.registerTool({
-    name: "camoufox_scroll",
-    description: "Scroll the page.",
-    parameters: {
-      type: "object",
-      properties: {
-        tabId: { type: "string", description: "Tab identifier" },
-        userId: { type: "string", description: "User identifier" },
-        direction: { type: "string", enum: ["up", "down", "left", "right"] },
-        amount: { type: "number", description: "Pixels to scroll" },
+  api.registerTool(
+    {
+      name: "camoufox_scroll",
+      description: "Scroll the page.",
+      parameters: {
+        type: "object",
+        properties: {
+          tabId: { type: "string", description: "Tab identifier" },
+          userId: { type: "string", description: "User identifier" },
+          direction: { type: "string", enum: ["up", "down", "left", "right"] },
+          amount: { type: "number", description: "Pixels to scroll" },
+        },
+        required: ["tabId", "userId", "direction"],
+      },
+      async execute(_id, params) {
+        const { tabId, ...body } = params as { tabId: string } & Record<string, unknown>;
+        const result = await fetchApi(baseUrl, `/tabs/${tabId}/scroll`, {
+          method: "POST",
+          body: JSON.stringify(body),
+        });
+        return toToolResult(result);
       },
-      required: ["tabId", "userId", "direction"],
-    },
-    optional: true,
-    handler: async (params) => {
-      const { tabId, ...body } = params as { tabId: string } & Record<string, unknown>;
-      return fetchApi(baseUrl, `/tabs/${tabId}/scroll`, {
-        method: "POST",
-        body: JSON.stringify(body),
-      });
     },
-  });
+    { optional: true }
+  );
 
-  api.registerTool({
-    name: "camoufox_screenshot",
-    description: "Take a screenshot of the current page.",
-    parameters: {
-      type: "object",
-      properties: {
-        tabId: { type: "string", description: "Tab identifier" },
-        userId: { type: "string", description: "User identifier" },
+  api.registerTool(
+    {
+      name: "camoufox_screenshot",
+      description: "Take a screenshot of the current page.",
+      parameters: {
+        type: "object",
+        properties: {
+          tabId: { type: "string", description: "Tab identifier" },
+          userId: { type: "string", description: "User identifier" },
+        },
+        required: ["tabId", "userId"],
+      },
+      async execute(_id, params) {
+        const { tabId, userId } = params as { tabId: string; userId: string };
+        const result = await fetchApi(baseUrl, `/tabs/${tabId}/screenshot?userId=${userId}`);
+        return toToolResult(result);
       },
-      required: ["tabId", "userId"],
-    },
-    optional: true,
-    handler: async (params) => {
-      const { tabId, userId } = params as { tabId: string; userId: string };
-      return fetchApi(baseUrl, `/tabs/${tabId}/screenshot?userId=${userId}`);
     },
-  });
+    { optional: true }
+  );
 
-  api.registerTool({
-    name: "camoufox_close_tab",
-    description: "Close a browser tab.",
-    parameters: {
-      type: "object",
-      properties: {
-        tabId: { type: "string", description: "Tab identifier" },
-        userId: { type: "string", description: "User identifier" },
+  api.registerTool(
+    {
+      name: "camoufox_close_tab",
+      description: "Close a browser tab.",
+      parameters: {
+        type: "object",
+        properties: {
+          tabId: { type: "string", description: "Tab identifier" },
+          userId: { type: "string", description: "User identifier" },
+        },
+        required: ["tabId", "userId"],
+      },
+      async execute(_id, params) {
+        const { tabId, userId } = params as { tabId: string; userId: string };
+        const result = await fetchApi(baseUrl, `/tabs/${tabId}?userId=${userId}`, {
+          method: "DELETE",
+        });
+        return toToolResult(result);
       },
-      required: ["tabId", "userId"],
-    },
-    optional: true,
-    handler: async (params) => {
-      const { tabId, userId } = params as { tabId: string; userId: string };
-      return fetchApi(baseUrl, `/tabs/${tabId}?userId=${userId}`, {
-        method: "DELETE",
-      });
     },
-  });
+    { optional: true }
+  );
 
-  api.registerTool({
-    name: "camoufox_list_tabs",
-    description: "List all open tabs for a user.",
-    parameters: {
-      type: "object",
-      properties: {
-        userId: { type: "string", description: "User identifier" },
+  api.registerTool(
+    {
+      name: "camoufox_list_tabs",
+      description: "List all open tabs for a user.",
+      parameters: {
+        type: "object",
+        properties: {
+          userId: { type: "string", description: "User identifier" },
+        },
+        required: ["userId"],
+      },
+      async execute(_id, params) {
+        const { userId } = params as { userId: string };
+        const result = await fetchApi(baseUrl, `/tabs?userId=${userId}`);
+        return toToolResult(result);
       },
-      required: ["userId"],
-    },
-    optional: true,
-    handler: async (params) => {
-      const { userId } = params as { userId: string };
-      return fetchApi(baseUrl, `/tabs?userId=${userId}`);
     },
-  });
+    { optional: true }
+  );
 
   api.registerCommand({
     name: "camoufox",

package/.env.bak

@@ -1,4 +0,0 @@
-PROXY_HOST=166.88.179.132
-PROXY_PORT=46040
-PROXY_USERNAME=NleQYPIiORIbOYT
-PROXY_PASSWORD=936asYRvpdftjI6

package/.github/workflows/deploy.yml

@@ -1,21 +0,0 @@
-name: Deploy to Fly.io
-
-on:
-  push:
-    branches:
-      - master
-      - main
-
-jobs:
-  deploy:
-    name: Deploy to Fly.io
-    runs-on: ubuntu-latest
-    concurrency: deploy-group
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: superfly/flyctl-actions/setup-flyctl@master
-
-      - run: flyctl deploy --remote-only
-        env:
-          FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}