[Components] browserbase #15425

Sources
 - New Session

Actions
 - Create Session
 - Create Context
 - List Projects

Author: luancazarine

components/browserbase/actions/create-context/create-context.mjs

@@ -1,11 +1,10 @@
 import browserbase from "../../browserbase.app.mjs";
-import { axios } from "@pipedream/platform";
 
 export default {
   key: "browserbase-create-context",
   name: "Create Context",
   description: "Creates a new context in Browserbase. [See the documentation](https://docs.browserbase.com/reference/api/create-a-context)",
-  version: "0.0.{{ts}}",
+  version: "0.0.1",
   type: "action",
   props: {
     browserbase,
@@ -18,7 +17,10 @@ export default {
   },
   async run({ $ }) {
     const response = await this.browserbase.createContext({
-      projectId: this.projectId,
+      $,
+      data: {
+        projectId: this.projectId,
+      },
     });
 
     $.export("$summary", `Successfully created context with ID: ${response.id}`);

components/browserbase/actions/create-session/create-session.mjs

@@ -1,11 +1,12 @@
 import browserbase from "../../browserbase.app.mjs";
-import { axios } from "@pipedream/platform";
+import { REGION_OPTIONS } from "../../common/constants.mjs";
+import { parseObject } from "../../common/utils.mjs";
 
 export default {
   key: "browserbase-create-session",
   name: "Create Session",
   description: "Creates a new browser session with specified settings. [See the documentation](https://docs.browserbase.com/reference/api/create-a-session)",
-  version: "0.0.{{ts}}",
+  version: "0.0.1",
   type: "action",
   props: {
     browserbase,
@@ -16,65 +17,64 @@ export default {
       ],
     },
     extensionId: {
-      propDefinition: [
-        browserbase,
-        "extensionId",
-      ],
+      type: "string",
+      label: "Extension ID",
+      description: "The uploaded Extension ID",
       optional: true,
     },
     browserSettings: {
-      propDefinition: [
-        browserbase,
-        "browserSettings",
-      ],
+      type: "object",
+      label: "Browser Settings",
+      description: "An object with the settings for the session. [See the documentation](https://docs.browserbase.com/reference/api/create-a-session#body-browser-settings) for more details.",
       optional: true,
     },
     timeout: {
-      propDefinition: [
-        browserbase,
-        "timeout",
-      ],
+      type: "integer",
+      label: "Timeout",
+      description: "Duration in seconds after which the session will automatically end.",
+      min: 60,
+      max: 21600,
       optional: true,
     },
     keepAlive: {
-      propDefinition: [
-        browserbase,
-        "keepAlive",
-      ],
+      type: "boolean",
+      label: "Keep Alive",
+      description: "Set to true to keep the session alive even after disconnections.",
       optional: true,
     },
     proxies: {
-      propDefinition: [
-        browserbase,
-        "proxies",
-      ],
+      type: "string[]",
+      label: "Proxies",
+      description: "An array of objects with proxy configuration. [See the documentation](https://docs.browserbase.com/reference/api/create-a-session#body-proxies) for more details.",
       optional: true,
     },
     region: {
-      propDefinition: [
-        browserbase,
-        "region",
-      ],
+      type: "string",
+      label: "Region",
+      description: "The region where the session should run.",
+      options: REGION_OPTIONS,
       optional: true,
     },
     userMetadata: {
-      propDefinition: [
-        browserbase,
-        "userMetadata",
-      ],
+      type: "object",
+      label: "User Metadata",
+      description: "Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](https://docs.browserbase.com/features/sessions#user-metadata).",
       optional: true,
     },
   },
   async run({ $ }) {
     const response = await this.browserbase.createSession({
-      projectId: this.projectId,
-      extensionId: this.extensionId,
-      browserSettings: this.browserSettings,
-      timeout: this.timeout,
-      keepAlive: this.keepAlive,
-      proxies: this.proxies && this.proxies.map(JSON.parse),
-      region: this.region,
-      userMetadata: this.userMetadata,
+      $,
+      data: {
+        projectId: this.projectId,
+        extensionId: this.extensionId,
+        browserSettings: parseObject(this.browserSettings),
+        timeout: this.timeout,
+        keepAlive: this.keepAlive,
+        proxies: parseObject(this.proxies),
+        region: this.region,
+        userMetadata: parseObject(this.userMetadata),
+      },
     });
 
     $.export("$summary", `Session created successfully with ID: ${response.id}`);

components/browserbase/actions/list-projects/list-projects.mjs

@@ -1,18 +1,19 @@
 import browserbase from "../../browserbase.app.mjs";
-import { axios } from "@pipedream/platform";
 
 export default {
   key: "browserbase-list-projects",
   name: "List Projects",
   description: "Lists all projects. [See the documentation](https://docs.browserbase.com/reference/api/list-projects)",
-  version: "0.0.{{ts}}",
+  version: "0.0.1",
   type: "action",
   props: {
     browserbase,
   },
   async run({ $ }) {
-    const projects = await this.browserbase.listProjects();
-    $.export("$summary", `Successfully listed ${projects.length} projects.`);
+    const projects = await this.browserbase.listProjects({
+      $,
+    });
+    $.export("$summary", `Successfully listed ${projects.length} project(s).`);
     return projects;
   },
 };

components/browserbase/browserbase.app.mjs

@@ -4,18 +4,6 @@ export default {
   type: "app",
   app: "browserbase",
   propDefinitions: {
-    sessionId: {
-      type: "string",
-      label: "Session ID",
-      description: "The ID of the session",
-      async options() {
-        const sessions = await this.listSessions();
-        return sessions.map((session) => ({
-          value: session.id,
-          label: session.id,
-        }));
-      },
-    },
     projectId: {
       type: "string",
       label: "Project ID",
@@ -28,179 +16,51 @@ export default {
         }));
       },
     },
-    extensionId: {
-      type: "string",
-      label: "Extension ID",
-      description: "The uploaded Extension ID",
-      optional: true,
-    },
-    browserSettings: {
-      type: "object",
-      label: "Browser Settings",
-      description: "The settings for the browser",
-      optional: true,
-    },
-    timeout: {
-      type: "integer",
-      label: "Timeout",
-      description: "Duration in seconds after which the session will automatically end.",
-      optional: true,
-      min: 60,
-      max: 21600,
-    },
-    keepAlive: {
-      type: "boolean",
-      label: "Keep Alive",
-      description: "Set to true to keep the session alive even after disconnections.",
-      optional: true,
-    },
-    proxies: {
-      type: "string[]",
-      label: "Proxies",
-      description: "Proxy configuration. Can be true for default proxy, or an array of proxy configurations.",
-      optional: true,
-    },
-    region: {
-      type: "string",
-      label: "Region",
-      description: "The region where the session should run.",
-      options: [
-        {
-          label: "US West 2",
-          value: "us-west-2",
-        },
-        {
-          label: "US East 1",
-          value: "us-east-1",
-        },
-        {
-          label: "EU Central 1",
-          value: "eu-central-1",
-        },
-        {
-          label: "AP Southeast 1",
-          value: "ap-southeast-1",
-        },
-      ],
-      optional: true,
-    },
-    userMetadata: {
-      type: "object",
-      label: "User Metadata",
-      description: "Arbitrary user metadata to attach to the session.",
-      optional: true,
-    },
   },
   methods: {
     _baseUrl() {
       return "https://api.browserbase.com/v1";
     },
-    async _makeRequest(opts = {}) {
-      const {
-        $ = this, method = "GET", path = "/", headers, ...otherOpts
-      } = opts;
+    _headers() {
+      return {
+        "x-bb-api-key": `${this.$auth.api_key}`,
+        "Content-Type": "application/json",
+      };
+    },
+    _makeRequest({
+      $ = this, path, ...opts
+    }) {
       return axios($, {
-        ...otherOpts,
-        method,
         url: this._baseUrl() + path,
-        headers: {
-          ...headers,
-          "X-BB-API-Key": this.$auth.api_key,
-        },
+        headers: this._headers(),
+        ...opts,
       });
     },
-    async listProjects(opts = {}) {
+    listProjects(opts = {}) {
       return this._makeRequest({
         path: "/projects",
         ...opts,
       });
     },
-    async listSessions(opts = {}) {
+    listSessions(opts = {}) {
       return this._makeRequest({
         path: "/sessions",
         ...opts,
       });
     },
-    async createSession(opts = {}) {
-      const {
-        projectId, extensionId, browserSettings, timeout, keepAlive, proxies, region, userMetadata, ...otherOpts
-      } = opts;
-      const data = {
-        projectId,
-        extensionId,
-        browserSettings,
-        timeout,
-        keepAlive,
-        proxies,
-        region,
-        userMetadata,
-      };
+    createSession(opts = {}) {
       return this._makeRequest({
         method: "POST",
         path: "/sessions",
-        data,
-        ...otherOpts,
+        ...opts,
       });
     },
-    async createContext(opts = {}) {
-      const {
-        projectId, ...otherOpts
-      } = opts;
+    createContext(opts = {}) {
       return this._makeRequest({
         method: "POST",
         path: "/contexts",
-        data: {
-          projectId,
-        },
-        ...otherOpts,
-      });
-    },
-    async getSessionLogs(opts = {}) {
-      const {
-        sessionId, ...otherOpts
-      } = opts;
-      return this._makeRequest({
-        path: `/sessions/${sessionId}/logs`,
-        ...otherOpts,
+        ...opts,
       });
     },
   },
-  hooks: {
-    async activate() {
-      this._checkForNewProjects();
-      this._checkForNewSessions();
-    },
-  },
-  async _checkForNewProjects() {
-    const projects = await this.listProjects();
-    for (const project of projects) {
-      this.$emit(project, {
-        id: project.id,
-        summary: project.name,
-        ts: new Date().getTime(),
-      });
-    }
-  },
-  async _checkForNewSessions() {
-    const sessions = await this.listSessions();
-    for (const session of sessions) {
-      this.$emit(session, {
-        id: session.id,
-        summary: `New session: ${session.id}`,
-        ts: new Date().getTime(),
-      });
-    }
-  },
-  async _checkForNewLogs(sessionId) {
-    const logs = await this.getSessionLogs({
-      sessionId,
-    });
-    for (const log of logs) {
-      this.$emit(log, {
-        id: log.id,
-        summary: `Log for session: ${sessionId}`,
-        ts: new Date().getTime(),
-      });
-    }
-  },
 };