@hyperbrowser/sdk 0.11.0 → 0.12.0

package/dist/services/extensions.d.ts

@@ -1,12 +1,11 @@
-import { CreateExtensionResponse, ListExtensionsResponse } from "../types/extension";
+import { CreateExtensionParams, CreateExtensionResponse, ListExtensionsResponse } from "../types/extension";
 import { BaseService } from "./base";
 export declare class ExtensionService extends BaseService {
     /**
      * Upload an extension to hyperbrowser
-     * @param {string} filePath Path to a zipped extension. Extension must be Manifest V3 compliant.
-     * @param {string} [fileName] Name to give to the extension.
+     * @param params Configuration parameters for the new extension
      */
-    create(filePath: string, fileName?: string | undefined): Promise<CreateExtensionResponse>;
+    create(params: CreateExtensionParams): Promise<CreateExtensionResponse>;
     /**
      * List all uploaded extensions for the account
      */

package/dist/services/extensions.js

@@ -27,19 +27,18 @@ async function checkFileExists(filePath) {
 class ExtensionService extends base_1.BaseService {
     /**
      * Upload an extension to hyperbrowser
-     * @param {string} filePath Path to a zipped extension. Extension must be Manifest V3 compliant.
-     * @param {string} [fileName] Name to give to the extension.
+     * @param params Configuration parameters for the new extension
      */
-    async create(filePath, fileName) {
+    async create(params) {
         try {
-            await checkFileExists(filePath);
+            await checkFileExists(params.filePath);
             const form = new form_data_1.default();
-            form.append("file", await promises_1.default.readFile(filePath), {
-                filename: node_path_1.default.basename(filePath),
+            form.append("file", await promises_1.default.readFile(params.filePath), {
+                filename: node_path_1.default.basename(params.filePath),
                 contentType: "application/zip",
             });
-            if (fileName) {
-                form.append("name", fileName);
+            if (params.name) {
+                form.append("name", params.name);
             }
             const response = await this.request("/extensions/add", {
                 method: "POST",

package/dist/types/extension.d.ts

@@ -1,3 +1,7 @@
+export interface CreateExtensionParams {
+    filePath: string;
+    name?: string;
+}
 interface ExtensionResponse {
     name: string;
     id: string;

package/dist/types/index.d.ts

@@ -3,4 +3,5 @@ export { StartCrawlJobParams, StartCrawlJobResponse, CrawledPage, CrawlJobRespon
 export { StartScrapeJobParams, StartScrapeJobResponse, ScrapeJobData, ScrapeJobResponse, } from "./scrape";
 export { BasicResponse, SessionStatus, Session, SessionDetail, SessionListParams, SessionListResponse, ScreenConfig, CreateSessionParams, } from "./session";
 export { ProfileResponse, CreateProfileResponse } from "./profile";
+export { CreateExtensionParams, CreateExtensionResponse, ListExtensionsResponse, } from "./extension";
 export { ScrapeJobStatus, CrawlJobStatus, Country, ISO639_1, OperatingSystem, Platform, } from "./constants";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperbrowser/sdk",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Node SDK for Hyperbrowser API",
   "author": "",
   "main": "dist/index.js",