@airtop/sdk 0.1.36 → 0.1.37-beta1

package/wrapper/AirtopSessions.js

@@ -1,4 +1,37 @@
 "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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 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) {
@@ -15,9 +48,16 @@ var __asyncValues = (this && this.__asyncValues) || function (o) {
     function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
     function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AirtopSessions = void 0;
+const readable_stream_1 = require("readable-stream");
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
 const Client_1 = require("../api/resources/sessions/client/Client");
+const node_fetch_1 = __importDefault(require("node-fetch"));
 class AirtopSessions extends Client_1.Sessions {
     constructor(_options, debug = false) {
         super(_options);
@@ -66,30 +106,209 @@ class AirtopSessions extends Client_1.Sessions {
             }
         });
     }
+    /**
+     * Waits for a session to enter the 'running' status
+     *
+     * @param id - The ID of the session to wait for
+     * @param requestOptions - Optional request configuration including timeout
+     * @returns The session event indicating the session is ready, or null if timed out
+     */
     waitForSessionReady(id, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, e_1, _b, _c;
-            const sessionEvents = yield this.events(id, {}, Object.assign({ timeoutInSeconds: 60 }, (requestOptions || {})));
-            try {
-                for (var _d = true, sessionEvents_1 = __asyncValues(sessionEvents), sessionEvents_1_1; sessionEvents_1_1 = yield sessionEvents_1.next(), _a = sessionEvents_1_1.done, !_a; _d = true) {
-                    _c = sessionEvents_1_1.value;
-                    _d = false;
-                    const event = _c;
-                    this.log(`status message received:\n${JSON.stringify(event, null, 2)}`);
-                    const e = event;
-                    if (e.event === 'status' && e.status === 'running') {
-                        return event;
+            const timeoutSeconds = (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) || 300;
+            // Create a promise that resolves to null after the timeout
+            const timeoutPromise = new Promise((resolve) => {
+                setTimeout(() => resolve(null), timeoutSeconds * 1000);
+            });
+            // Create a promise for the event processing
+            const processEventsPromise = (() => __awaiter(this, void 0, void 0, function* () {
+                var _a, e_1, _b, _c;
+                const sessionEvents = yield this.events(id, {}, Object.assign({ timeoutInSeconds: timeoutSeconds }, (requestOptions || {})));
+                try {
+                    for (var _d = true, sessionEvents_1 = __asyncValues(sessionEvents), sessionEvents_1_1; sessionEvents_1_1 = yield sessionEvents_1.next(), _a = sessionEvents_1_1.done, !_a; _d = true) {
+                        _c = sessionEvents_1_1.value;
+                        _d = false;
+                        const event = _c;
+                        const e = event;
+                        if (e.event === 'status') {
+                            this.log(`status message received:\n${JSON.stringify(event, null, 2)}`);
+                            if (e.status === 'running') {
+                                return event;
+                            }
+                        }
                     }
                 }
-            }
-            catch (e_1_1) { e_1 = { error: e_1_1 }; }
-            finally {
+                catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                finally {
+                    try {
+                        if (!_d && !_a && (_b = sessionEvents_1.return)) yield _b.call(sessionEvents_1);
+                    }
+                    finally { if (e_1) throw e_1.error; }
+                }
+                return null;
+            }))();
+            // Race the timeout against the event processing
+            return Promise.race([timeoutPromise, processEventsPromise]);
+        });
+    }
+    /**
+     * Waits for a file to be downloaded in a session and reach 'available' status.
+     * Defaults to looking back 5 seconds in the event stream for the file to be available.
+     * Use `includePriorEvents` and `lookbackSeconds` to control this behavior.
+     *
+     * @param {Object} params - The parameters for the function
+     * @param {string} params.sessionId - The ID of the session to monitor
+     * @param {boolean} [params.includePriorEvents=true] - Whether to include prior events in the wait. Default `true`.
+     * @param {number} [params.lookbackSeconds=5] - The number of seconds to look back for prior events. Default `5`.
+     * @param {Sessions.RequestOptions} [requestOptions] - Optional request configuration including timeout
+     * @returns {Promise<{ id: string, downloadUrl: string } | null>} Object containing file's id and downloadUrl, or null if timed out
+     */
+    waitForDownload(sessionId, configuration, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { includePriorEvents = true, lookbackSeconds = 5 } = configuration || {};
+            const startTime = new Date();
+            const timeoutSeconds = (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) || 120;
+            // Create a promise that resolves to null after the timeout
+            const timeoutPromise = new Promise((resolve) => {
+                setTimeout(() => resolve(null), timeoutSeconds * 1000);
+            });
+            // Create a promise for the event processing
+            const processEventsPromise = (() => __awaiter(this, void 0, void 0, function* () {
+                var _a, e_2, _b, _c;
+                const sessionEvents = yield this.events(sessionId, { all: includePriorEvents }, Object.assign({ timeoutInSeconds: timeoutSeconds }, (requestOptions || {})));
                 try {
-                    if (!_d && !_a && (_b = sessionEvents_1.return)) yield _b.call(sessionEvents_1);
+                    for (var _d = true, sessionEvents_2 = __asyncValues(sessionEvents), sessionEvents_2_1; sessionEvents_2_1 = yield sessionEvents_2.next(), _a = sessionEvents_2_1.done, !_a; _d = true) {
+                        _c = sessionEvents_2_1.value;
+                        _d = false;
+                        const event = _c;
+                        const e = event;
+                        if (e.event === 'file_status') {
+                            if (e.status === 'available') {
+                                const eventTime = Date.parse(e.eventTime);
+                                this.log(`file_status message received:\n${JSON.stringify(event, null, 2)}`);
+                                const thresholdTime = startTime.getTime() - lookbackSeconds * 1000;
+                                if (eventTime < thresholdTime) {
+                                    this.log(`skipping file available event for ${e.fileId} because its timestamp is earlier than lookbackSeconds`);
+                                    continue;
+                                }
+                                return {
+                                    id: e.fileId,
+                                    downloadUrl: e.downloadUrl,
+                                };
+                            }
+                        }
+                    }
+                }
+                catch (e_2_1) { e_2 = { error: e_2_1 }; }
+                finally {
+                    try {
+                        if (!_d && !_a && (_b = sessionEvents_2.return)) yield _b.call(sessionEvents_2);
+                    }
+                    finally { if (e_2) throw e_2.error; }
                 }
-                finally { if (e_1) throw e_1.error; }
+                return null;
+            }))();
+            // Race the timeout against the event processing
+            return Promise.race([timeoutPromise, processEventsPromise]);
+        });
+    }
+    /**
+     * Waits for a file download to start in a session
+     *
+     * @param {Object} params - The parameters for the function
+     * @param {string} params.sessionId - The ID of the session to monitor
+     * @param {boolean} [params.includePriorEvents=false] - Whether to include prior events in the wait
+     * @param {Sessions.RequestOptions} [requestOptions] - Optional request configuration including timeout
+     * @returns {Promise<{ id: string, downloadUrl: string } | null>} Object containing file's id and downloadUrl, or null if timed out
+     */
+    waitForDownloadStart(_a, requestOptions_1) {
+        return __awaiter(this, arguments, void 0, function* ({ sessionId, includePriorEvents = false }, requestOptions) {
+            const timeoutSeconds = (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) || 60;
+            // Create a promise that resolves to null after the timeout
+            const timeoutPromise = new Promise((resolve) => {
+                setTimeout(() => resolve(null), timeoutSeconds * 1000);
+            });
+            // Create a promise for the event processing
+            const processEventsPromise = (() => __awaiter(this, void 0, void 0, function* () {
+                var _a, e_3, _b, _c;
+                const sessionEvents = yield this.events(sessionId, { all: includePriorEvents }, Object.assign({ timeoutInSeconds: timeoutSeconds }, (requestOptions || {})));
+                try {
+                    for (var _d = true, sessionEvents_3 = __asyncValues(sessionEvents), sessionEvents_3_1; sessionEvents_3_1 = yield sessionEvents_3.next(), _a = sessionEvents_3_1.done, !_a; _d = true) {
+                        _c = sessionEvents_3_1.value;
+                        _d = false;
+                        const event = _c;
+                        const e = event;
+                        if (e.event === 'file_status') {
+                            this.log(`file_status message received:\n${JSON.stringify(event, null, 2)}`);
+                            if (e.status === 'uploading') {
+                                return {
+                                    id: e.fileId,
+                                    downloadUrl: e.downloadUrl,
+                                };
+                            }
+                        }
+                    }
+                }
+                catch (e_3_1) { e_3 = { error: e_3_1 }; }
+                finally {
+                    try {
+                        if (!_d && !_a && (_b = sessionEvents_3.return)) yield _b.call(sessionEvents_3);
+                    }
+                    finally { if (e_3) throw e_3.error; }
+                }
+                return null;
+            }))();
+            // Race the timeout against the event processing
+            return Promise.race([timeoutPromise, processEventsPromise]);
+        });
+    }
+    /**
+     * Downloads the next file from a session as soon as it starts to become available
+     *
+     * @param {Object} params - The parameters for the function
+     * @param {string} params.sessionId - The ID of the session to download from
+     * @param {string} params.destinationPath - The local path where the file should be saved
+     * @param {function} [params.onProgress] - Optional callback to track download progress
+     * @param {boolean} [params.includePriorEvents=false] - Whether to include prior events in the wait
+     * @param {Sessions.RequestOptions} [requestOptions] - Optional request configuration including timeout
+     * @throws Error if no file is available to download within the timeout period
+     */
+    downloadNextFile(_a, requestOptions_1) {
+        return __awaiter(this, arguments, void 0, function* ({ sessionId, destinationPath, onProgress, includePriorEvents = false, }, requestOptions) {
+            var _b;
+            const nextFile = yield this.waitForDownload(sessionId, { includePriorEvents }, requestOptions);
+            if (!nextFile) {
+                throw new Error('No file to download within timeout');
+            }
+            const downloadResponse = yield (0, node_fetch_1.default)(nextFile.downloadUrl);
+            if (!downloadResponse.ok) {
+                throw new Error(`Failed to download file: ${downloadResponse.statusText}`);
             }
-            return null;
+            const totalBytes = Number.parseInt((_b = downloadResponse.headers.get('content-length')) !== null && _b !== void 0 ? _b : '0', 10);
+            let downloadedBytes = 0;
+            fs.mkdirSync(path.dirname(destinationPath), { recursive: true });
+            const fileStream = fs.createWriteStream(destinationPath);
+            yield new Promise((resolve, reject) => {
+                var _a, _b;
+                if (onProgress && downloadResponse.body) {
+                    // Create a transform stream to track progress
+                    const progressStream = new readable_stream_1.Transform({
+                        transform(chunk, encoding, callback) {
+                            downloadedBytes += chunk.length;
+                            onProgress(downloadedBytes, totalBytes);
+                            callback(null, chunk);
+                        },
+                    });
+                    downloadResponse.body.pipe(progressStream).pipe(fileStream);
+                    progressStream.on('error', reject);
+                }
+                else {
+                    // If no progress callback, pipe directly
+                    (_a = downloadResponse.body) === null || _a === void 0 ? void 0 : _a.pipe(fileStream);
+                }
+                (_b = downloadResponse.body) === null || _b === void 0 ? void 0 : _b.on('error', reject);
+                fileStream.on('finish', resolve);
+            });
         });
     }
 }