@airtop/sdk 0.1.5 → 0.1.7

package/dist/utils/batch-operate/batch-util.js

@@ -0,0 +1,51 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.batchOperate = void 0;
+const node_events_1 = require("node:events");
+const helpers_1 = require("./helpers");
+const SessionQueue_1 = require("./SessionQueue");
+const DEFAULT_MAX_WINDOWS_PER_SESSION = 1;
+const DEFAULT_MAX_CONCURRENT_SESSIONS = 30;
+const batchOperate = (urls, operation, // operation to invoke on each url
+client, config) => __awaiter(void 0, void 0, void 0, function* () {
+    // Validate the urls before proceeding
+    if (!Array.isArray(urls)) {
+        throw new Error("Please provide a valid list of urls");
+    }
+    for (const url of urls) {
+        if (!url || typeof url !== "object" || !("url" in url)) {
+            throw new Error("Please provide a valid list of urls");
+        }
+    }
+    const runEmitter = new node_events_1.EventEmitter();
+    const { maxConcurrentSessions = DEFAULT_MAX_CONCURRENT_SESSIONS, maxWindowsPerSession = DEFAULT_MAX_WINDOWS_PER_SESSION, sessionConfig, onError, } = config !== null && config !== void 0 ? config : {};
+    // Set the maximum number of listeners to accommodate all concurrent sessions and windows
+    runEmitter.setMaxListeners(maxConcurrentSessions + (maxConcurrentSessions * maxWindowsPerSession) + 1);
+    // Split the urls into batches
+    const initialBatches = (0, helpers_1.distributeUrlsToBatches)(urls, maxConcurrentSessions);
+    const sessionQueue = new SessionQueue_1.SessionQueue({
+        maxConcurrentSessions,
+        runEmitter,
+        maxWindowsPerSession,
+        initialBatches,
+        operation,
+        client,
+        sessionConfig,
+        onError,
+    });
+    runEmitter.on("addUrls", (additionalUrls) => {
+        sessionQueue.addUrlsToBatchQueue(additionalUrls);
+    });
+    yield sessionQueue.processInitialBatches();
+    return yield sessionQueue.waitForProcessingToComplete();
+});
+exports.batchOperate = batchOperate;

package/dist/utils/batch-operate/helpers.d.ts

@@ -0,0 +1,2 @@
+import type { BatchOperationUrl } from "./types";
+export declare const distributeUrlsToBatches: (urls: BatchOperationUrl[], maxConcurrentSessions: number) => BatchOperationUrl[][];

package/dist/utils/batch-operate/helpers.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.distributeUrlsToBatches = void 0;
+const distributeUrlsToBatches = (urls, maxConcurrentSessions) => {
+    if (urls.length === 0)
+        return [];
+    // Calculate optimal number of batches
+    const batchCount = Math.min(maxConcurrentSessions, urls.length);
+    const batches = Array.from({ length: batchCount }, () => []);
+    urls.forEach((url, index) => {
+        const batchIndex = index % batchCount;
+        if (!batches[batchIndex]) {
+            batches[batchIndex] = [];
+        }
+        batches[batchIndex].push(url);
+    });
+    return batches;
+};
+exports.distributeUrlsToBatches = distributeUrlsToBatches;

package/dist/utils/batch-operate/types.d.ts

@@ -0,0 +1,29 @@
+import type { AirtopSessionConfigV1 } from "wrapper/AirtopSessions";
+export declare type BatchOperateConfig = {
+    maxConcurrentSessions?: number;
+    maxWindowsPerSession?: number;
+    sessionConfig?: AirtopSessionConfigV1;
+    onError?: (error: BatchOperationError) => Promise<void>;
+};
+export declare type BatchOperationUrl = {
+    url: string;
+    context?: Record<string, unknown>;
+};
+export declare type BatchOperationInput = {
+    windowId: string;
+    sessionId: string;
+    liveViewUrl: string;
+    operationUrl: BatchOperationUrl;
+};
+export declare type BatchOperationResponse<T> = {
+    shouldHaltBatch?: boolean;
+    additionalUrls?: BatchOperationUrl[];
+    data?: T;
+};
+export declare type BatchOperationError = {
+    error: Error | string;
+    operationUrls: BatchOperationUrl[];
+    sessionId?: string;
+    windowId?: string;
+    liveViewUrl?: string;
+};

package/dist/utils/batch-operate/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./batch-operate/batch-util";
+export * from "./batch-operate/types";

package/dist/utils/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./batch-operate/batch-util"), exports);
+__exportStar(require("./batch-operate/types"), exports);

package/dist/wrapper/AirtopClient.d.ts

@@ -1,6 +1,7 @@
 import { AirtopClient as FernClient } from '../Client';
 import { AirtopSessions } from './AirtopSessions';
 import { AirtopWindows } from './AirtopWindows';
+import { type BatchOperateConfig, type BatchOperationInput, type BatchOperationResponse, type BatchOperationUrl } from "../utils";
 declare type AugmentedOptions = FernClient.Options & {
     debug?: boolean;
 };
@@ -15,6 +16,8 @@ export declare class AirtopClient {
     get windows(): AirtopWindows;
     get profiles(): import("../api/resources/profiles/client/Client").Profiles;
     log(message: string): void;
+    warn(message: string): void;
     error(err: any): void;
+    batchOperate: <T>(urls: BatchOperationUrl[], operation: (input: BatchOperationInput) => Promise<BatchOperationResponse<T>>, config?: BatchOperateConfig | undefined) => Promise<T[]>;
 }
 export {};

package/dist/wrapper/AirtopClient.js

@@ -1,12 +1,25 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AirtopClient = void 0;
 const Client_1 = require("../Client"); // alias the Fern generated client
 const AirtopSessions_1 = require("./AirtopSessions");
 const AirtopWindows_1 = require("./AirtopWindows");
+const utils_1 = require("../utils");
 class AirtopClient {
     constructor(_options) {
         this._options = _options;
+        this.batchOperate = (urls, operation, config) => __awaiter(this, void 0, void 0, function* () {
+            return yield (0, utils_1.batchOperate)(urls, operation, this, config);
+        });
         this._client = new Client_1.AirtopClient(_options);
         this.debug = (_options === null || _options === void 0 ? void 0 : _options.debug) || false;
     }
@@ -26,6 +39,9 @@ class AirtopClient {
             console.log(message);
         }
     }
+    warn(message) {
+        console.warn(message);
+    }
     error(err) {
         console.error(err);
     }

package/index.d.ts

@@ -4,3 +4,4 @@ export { AirtopEnvironment } from "./environments";
 export { AirtopError, AirtopTimeoutError } from "./errors";
 export { AirtopClient } from './wrapper/AirtopClient';
 export { LiveViewEventName, LiveViewMessage } from './live-view/types';
+export * from './utils';

package/index.js

@@ -22,6 +22,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LiveViewEventName = exports.AirtopClient = exports.AirtopTimeoutError = exports.AirtopError = exports.AirtopEnvironment = exports.Resources = exports.Airtop = void 0;
 exports.Airtop = __importStar(require("./api"));
@@ -35,3 +38,4 @@ var AirtopClient_1 = require("./wrapper/AirtopClient");
 Object.defineProperty(exports, "AirtopClient", { enumerable: true, get: function () { return AirtopClient_1.AirtopClient; } });
 var types_1 = require("./live-view/types");
 Object.defineProperty(exports, "LiveViewEventName", { enumerable: true, get: function () { return types_1.LiveViewEventName; } });
+__exportStar(require("./utils"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@airtop/sdk",
-    "version": "0.1.5",
+    "version": "0.1.7",
     "private": false,
     "repository": "https://github.com/airtop-ai/airtop-node-sdk",
     "main": "./index.js",
@@ -18,7 +18,8 @@
         "formdata-node": "^6.0.3",
         "node-fetch": "2.7.0",
         "qs": "6.11.2",
-        "js-base64": "3.7.2"
+        "js-base64": "3.7.2",
+        "async-mutex": "0.5.0"
     },
     "devDependencies": {
         "@types/url-join": "4.0.1",